Get Credit Application by ID
An introduction to the Get Credit Application by ID endpoint.
Early AccessCredit 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 InformationFor 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
applicationIdin the response when a credit application is created using the Create Credit Application or Submit Pre-Approved Application endpoint. Pass this value as theapplication_idpath 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
| Parameter | Type | Required | Description |
|---|---|---|---|
application_id | string | Required | The 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 theStandardReviewCreditApplicationResponseschema. - For pre-approved applications (
applicationType: pre_approved), the response follows thePreApprovedCreditApplicationResponseschema, which includes additional fields for credit limit, cash limit, and interest rates.
NoteIf the application ID is invalid or not found, the system returns a
422HTTP 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:
| Field | Type | Description |
|---|---|---|
applicationType | string | The type of application. Possible values: standard_review, pre_approved. |
applicationId | string | The unique ID of the application. |
accountHolderId | string | The unique ID of the account holder. |
accountId | string | The unique ID of the line of credit account. null until an account is created. |
status | string | The current status of the application. See Application Status below. |
createdAt | integer | Unix timestamp in microseconds when the application was created. |
updatedAt | integer | Unix timestamp in microseconds when the application was last updated. |
clientAssignedId | integer | The identifier assigned to the customer record in the LoanPro LMS. |
clientAssignedLocId | integer | The identifier assigned to the line of credit in the LoanPro LMS. |
employerName | string | The name of the applicant's employer, if provided. May be null. |
For pre-approved applications, the following additional fields are also returned:
| Field | Type | Description |
|---|---|---|
creditLimit | integer | The credit limit for the account. |
cashLimit | integer | The cash advance limit for the account. |
cashInterestRate | string | The interest rate for cash advances. |
purchasesInterestRate | string | The interest rate for purchases. |
Note
customerIdis 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
| Status | Description |
|---|---|
PENDED | The application is under review, pending identity verification or manual review checks. |
OFFER_PENDING_ACCEPTANCE | An offer has been generated and is awaiting the applicant's response. Applicants have 30 days to respond. |
OFFER_ACCEPTED | The applicant has accepted the offer. |
OFFER_DECLINED | The applicant has declined the offer. |
APPROVED | The application has been approved and the line of credit has been created. |
DECLINED | The application has been declined, for example due to failing credit, KYC, identity verification, or fraud checks. |
WITHDRAWN | The offer expired without a response from the applicant. |
More InformationTo 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.
Updated 4 days ago
