Application Lifecycle
A financing application follows a defined lifecycle that is managed by calling the Financing API endpoints.
When an application is created, it starts with the Draft status. While it is a draft, you can add the required documents to the application.
Once the application is complete, submit it by calling the Submit an application endpoint.
After submission, the application becomes read-only: you can no longer add documents or otherwise edit its details.
The lender reviews the submitted application and makes a decision. Record that decision by changing the application status to Approved or Rejected through the corresponding API endpoint.
Application Status flow
Draft
All new financing applications created through the Create Applications endpoint start with the Draft status.
While the application is a draft, you can retrieve it through the API and upload additional documents.
Submitted
After creating an application and adding its documents, you can submit it. The API forwards the application to the selected lender and marks it as read-only.
Read-only means that you can no longer upload documents or edit the application details. The only further status changes described here are to Approved or Rejected, which record the lender's decision.
Approved
When the lender approves an application, record the decision by approving the application.
The Approved status indicates that the loan has been approved and the application process is complete.
Financing API users are currently expected to record approved applications through the API.
Rejected
When the lender rejects an application, record the decision by rejecting the application.
The Rejected status indicates that the loan was not approved and the application process is complete.
Financing API users are currently expected to record rejected applications through the API.
Submit an application
Send POST /financing-applications/{id}/submit to submit an application. A successful response returns the application.
When an application cannot be found, the API returns a 404 Not Found response.
If an action cannot be performed because the application is in a status that does not allow changes, the API returns a 409 Conflict response.
Approve or reject an application
The API also provides:
POST /financing-applications/{id}/approvePOST /financing-applications/{id}/reject
When an application cannot be found, the API returns a 404 Not Found response.
If an action cannot be performed because the application is in a status that does not allow changes, the API returns a 409 Conflict response.
Use GET /financing-applications/{id} to retrieve the current application. See the Financing API reference for all response codes and schemas.