Get Credit Application by ID

An introduction to the Get Credit Application by ID 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 by ID endpoint retrieves the full details of a specific credit application, identified by its unique application ID.

An example of how you could use this functionality is to build a page in your user interface that displays the details of a specific application to a user — for example, the application status, product details, and applicant information.

📘

More Information

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

Prerequisites

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

  • Your own user interface, such as a mobile app or web page, to display application details to a user.
  • A valid application ID, returned as applicationId in the response when a credit application is created using the Create Credit Application or Submit Pre-Approved Application endpoint. Pass this value as the application_id path parameter below.

Example Request

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

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

Path Parameters

ParameterTypeRequiredDescription
application_idstringRequiredThe unique ID of the application.

Example Response

A successful request returns a 200 HTTP code. The response is the application object itself — there is no wrapper object.

The structure of the response depends on the applicationType:

  • For standard review applications (applicationType: standard_review), the response follows the StandardReviewCreditApplicationResponse schema.
  • For pre-approved applications (applicationType: pre_approved), the response follows the PreApprovedCreditApplicationResponse schema, which includes additional fields for credit limit, cash limit, and interest rates.
📘

Note

If the application ID is invalid or not found, the system returns a 422 HTTP error and details of the validation failure.

{
  "applicationType": "standard_review",
  "applicationId": "app_123456",
  "accountHolderId": "ah_123456",
  "accountId": null,
  "status": "PENDED",
  "productId": "prod_123456",
  "title": "Ms",
  "firstName": "Known",
  "middleName": "Lee",
  "lastName": "Person",
  "nameSuffix": "JR",
  "dateOfBirth": {
    "year": 1990,
    "month": 4,
    "day": 15
  },
  "nationalId": {
    "idNumber": "123-45-6789",
    "idType": "SSN"
  },
  "customerType": "INDIVIDUAL",
  "gender": "FEMALE",
  "email": "[email protected]",
  "residentialAddress": {
    "addressLine1": "1234 Test St",
    "city": "Any Town",
    "state": "TX",
    "zipCode": "73301",
    "country": "US"
  },
  "phoneNumbers": {
    "mobile": "+14155552671",
    "primaryContact": "MOBILE"
  },
  "employmentStatus": "EMPLOYED",
  "occupation": "Administrator",
  "totalAnnualIncome": 72000,
  "monthlyRentOrMortgage": 1200,
  "bankAccounts": "CHECKING_AND_SAVINGS",
  "usCitizen": true,
  "dualCitizenship": false,
  "consent": true,
  "ipAddress": "10.0.0.0",
  "createdAt": 1736238041798277,
  "updatedAt": 1736238041798277,
  "clientAssignedId": 100123,
  "clientAssignedLocId": 200456,
  "employerName": null
}
{
  "applicationType": "pre_approved",
  "applicationId": "app_789012",
  "accountHolderId": "ah_789012",
  "accountId": "acc_345678",
  "status": "APPROVED",
  "productId": "prod_123456",
  "title": "Ms",
  "firstName": "Known",
  "middleName": "Lee",
  "lastName": "Person",
  "nameSuffix": "JR",
  "dateOfBirth": {
    "year": 1990,
    "month": 4,
    "day": 15
  },
  "nationalId": {
    "idNumber": "123-45-6789",
    "idType": "SSN"
  },
  "customerType": "INDIVIDUAL",
  "gender": "FEMALE",
  "email": "[email protected]",
  "residentialAddress": {
    "addressLine1": "1234 Test St",
    "city": "Any Town",
    "state": "TX",
    "zipCode": "73301",
    "country": "US"
  },
  "phoneNumbers": {
    "mobile": "+14155552671",
    "primaryContact": "MOBILE"
  },
  "creditLimit": 5000,
  "cashLimit": 1000,
  "cashInterestRate": "24.99",
  "purchasesInterestRate": "19.99",
  "createdAt": 1736238041798277,
  "updatedAt": 1736238041798277,
  "clientAssignedId": 100123,
  "clientAssignedLocId": 200456,
  "employerName": "Acme Corp"
}
{
  "detail": [
    {
      "loc": ["path", "application_id"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Response Fields

The response contains all fields submitted at the time of application, plus the following response-only fields:

FieldTypeDescription
applicationTypestringThe type of application. Possible values: standard_review, pre_approved.
applicationIdstringThe unique ID of the application.
accountHolderIdstringThe unique ID of the account holder.
accountIdstringThe unique ID of the line of credit account. null until an account is created.
statusstringThe current status of the application. See Application Status below.
createdAtintegerUnix timestamp in microseconds when the application was created.
updatedAtintegerUnix timestamp in microseconds when the application was last updated.
clientAssignedIdintegerThe identifier assigned to the customer record in the LoanPro LMS.
clientAssignedLocIdintegerThe identifier assigned to the line of credit in the LoanPro LMS.
employerNamestringThe name of the applicant's employer, if provided. May be null.

For pre-approved applications, the following additional fields are also returned:

FieldTypeDescription
creditLimitintegerThe credit limit for the account.
cashLimitintegerThe cash advance limit for the account.
cashInterestRatestringThe interest rate for cash advances.
purchasesInterestRatestringThe interest rate for purchases.
📘

Note

customerId is only returned in the response when a pre-approved application is first created via Submit Pre-Approved Application. It is not included when retrieving the application later via this endpoint.

The optional applicant-detail fields available on pre-approved applications (employmentStatus, occupation, totalAnnualIncome, monthlyRentOrMortgage, bankAccounts, usCitizen, dualCitizenship, ipAddress) are also echoed back here if they were included at submission.

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 has been 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.
📘

More Information

To view the full history of status changes for an application, use the Get Credit Application Timeline endpoint. For more information about the application process, see Credit Applications and Origination.



Did this page help you?