Skip to main content
GET
Retrieve an application

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Server-generated ID (application_*) application ID Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

Response

Application object retrieved successfully.

An application object representing a credit application

id
string

Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

client_application_id
string
read-only

Client-provided identifier for the application. Optional: present only for applications created via file upload, and omitted for applications created through the API, which are identified solely by their server-generated ID.

created_at
string<date-time>

Lead server-generated ISO 8601 timestamp when the application was created.

updated_at
string<date-time>

Lead server-generated ISO 8601 timestamp when the application was last updated.

status
enum<string>

Terminal state of the application. Possible values: approved, declined, canceled.

Available options:
approved,
declined,
canceled
entities
object
read-only

Entity relationships associated with the application (response only)

details
object
read-only

Application details (response, all properties optional)

decision
object
read-only

Decision-related information (response, all properties optional)

documents
object[]

Documents associated with the application

metadata
object

Arbitrary metadata associated with the application