List Credit Applications

The List Credit Applications endpoint retrieves a list of all credit applications submitted by the client. Each item in the list is a summary of the application, including the application ID, product details, applicant name, email address, and the date the application was created.

An example of how you could use this functionality is to build a page in your user interface that displays a list of submitted applications, allowing a user to see all current and previous applications at a glance.

Prerequisites

To integrate calls to the List Credit Applications endpoint, you need:

• Your own user interface, such as a mobile app or web page, to display application information to a user.
• 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 a list of credit applications by making a GET request to the List Credit Applications endpoint.

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

Example Response

A successful request returns a 200 HTTP code and the response includes a creditApplications array.

Each item in the list is a summary of the application, including the application ID, current status, product details, applicant name, email address, associated account ID (if one exists), and the date the application was created.

{
  "creditApplications": [
    {
      "applicationId": "app_123456",
      "productId": "prod_123456",
      "productName": "Standard Credit Card",
      "productDescription": "A standard revolving line of credit.",
      "firstName": "Known",
      "lastName": "Person",
      "email": "[email protected]",
      "status": "PENDED",
      "nationalId": {
        "idNumber": "123-45-6789",
        "idType": "SSN"
      },
      "createdAt": 1736238041798277,
      "accountId": null
    },
    {
      "applicationId": "app_789012",
      "productId": "prod_789012",
      "productName": "Premium Credit Card",
      "productDescription": "A premium revolving line of credit.",
      "firstName": "Known",
      "lastName": "Person",
      "email": "[email protected]",
      "status": "APPROVED",
      "nationalId": {
        "idNumber": "123-45-6790",
        "idType": "SSN"
      },
      "createdAt": 1738581330123456,
      "accountId": "acc_456789"
    }
  ]
}

Response Fields

Each object in the creditApplications array contains the following fields: