Get Credit Application Timeline

An introduction to the Credit Application Timeline endpoint.

📘

Early Access

Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Get Credit Application Timeline endpoint allows you to retrieve the full history of status events for a specific credit application, identified by its unique application ID. The timeline is returned as an ordered list of events, each capturing the status reached, a timestamp, and a description of the event.

An example of how you could use this functionality is to build a page in your user interface that displays the current progress of an application to a user, or provides a complete audit trail of how an application moved through the origination process.

📘

More Information

For more information about the application process, see: Credit Applications and Origination.

Prerequisites

To integrate calls to the Get Credit Application Timeline endpoint, you need:

  • Your own user interface, such as a mobile app or web page, to display application status updates to a user.
  • A valid application ID, returned as applicationId in the response when a credit application is created using the Create Credit Application endpoint. Pass this value as the application_id path parameter below.
  • A subscription to Thredd webhooks so that you can receive application status updates in real time and communicate them to an applicant via your user interface.

Example Request

Retrieve the timeline for a credit application by making a GET request to the Get Credit Application Timeline endpoint, passing the application ID as a path parameter:

GET {{baseUrl}}/api/v1/credit/applications/{application_id}/timeline

Path Parameters

ParameterTypeRequiredDescription
application_idstringRequiredThe unique ID of the application.

Example Response

A successful request returns a 200 HTTP code. The response includes a timeline array of application events, ordered chronologically, along with the offerId, accountId, and accountHolderId associated with the application, where available.

If the request is invalid, the system will return a 422 HTTP error.

{
  "timeline": [
    {
      "applicationId": "app_123456",
      "status": "PENDED",
      "time": "2025-01-07T08:20:41Z",
      "title": "Application submitted",
      "description": "The application has been submitted and is under review."
    },
    {
      "applicationId": "app_123456",
      "status": "OFFER_PENDING_ACCEPTANCE",
      "time": "2025-01-07T09:15:00Z",
      "title": "Offer sent to client",
      "description": "An offer has been generated and is awaiting the applicant's response."
    },
    {
      "applicationId": "app_123456",
      "status": "OFFER_ACCEPTED",
      "time": "2025-01-07T10:30:00Z",
      "title": "Offer accepted",
      "description": "The applicant has accepted the offer and the application is approved."
    }
  ],
  "offerId": "offer_123456",
  "accountId": null,
  "accountHolderId": "ah_123456"
}

Response Fields

FieldTypeDescription
timelinearrayAn ordered list of application events. See below.
offerIdstringThe unique ID of the offer generated for the application, if one has been issued. May be null.
accountIdstringThe unique ID of the line of credit account, once created. May be null until the application is approved.
accountHolderIdstringThe unique ID of the account holder created for the applicant.

timeline array

Each item in the timeline array is an event object with the following fields:

FieldTypeDescription
applicationIdstringThe unique ID of the application.
statusstringThe application status at the time of the event. See Application Status below.
timestringThe date and time of the event, in ISO 8601 format.
titlestringA short title describing the event. See Event Titles below.
descriptionstringA description of the event.

Application Status

StatusDescription
PENDEDThe application is under review, pending identity verification or manual review checks.
OFFER_PENDING_ACCEPTANCEAn offer has been generated and is awaiting the applicant's response. Applicants have 30 days to respond.
OFFER_ACCEPTEDThe applicant has accepted the offer.
OFFER_DECLINEDThe applicant has declined the offer.
APPROVEDThe application is approved and the line of credit has been created.
DECLINEDThe application has been declined, for example due to failing credit, KYC, identity verification, or fraud checks.
WITHDRAWNThe offer expired without a response from the applicant.

Event Titles

TitleDescription
Application submittedThe application has been received and processing has begun.
Offer sent to clientAn offer has been generated and delivered to the client via webhook.
Offer acceptedThe applicant has accepted the offer.
Offer declinedThe applicant has declined the offer.
Application declinedThe application has been declined.
Account opened and card orderedThe application is approved, a line of credit has been created, and a payment card has been ordered.
Card createdThe payment card for the account has been created.
📘

Retrieving Application Status

You can also retrieve the current status of an application without the full timeline by passing the application ID in a GET request to the Get Credit Application by ID. For more information, see Get Credit Application by ID.



Did this page help you?