Skip to main content
GET
Retrieve an account

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Account ID The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

Response

Account object retrieved successfully.

An account object

id
string

The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

created_at
string<date-time>
read-only

Creation timestamp

updated_at
string<date-time>
read-only

Last update timestamp

application_id
string

Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

status
enum<string>

Current state of the account

Available options:
active,
inactive,
closed
status_reason
enum<string>

Machine-readable reason for the current status

Available options:
client_closed,
entity_closed,
frozen,
dormant,
active,
paid_off,
charged_off,
canceled,
other
capabilities
enum<string>[]

List of items that inform Lead how the Account will be used

Capability that informs Lead how the Account will be used

Available options:
deposit,
credit_with_underwriting,
credit_without_underwriting
entities
object
read-only

Entity relationships associated with the account (response only)

details
object
read-only

Core details of the account

metadata
object

A set of key-value pairs that can be used to store additional information related to this object.

documents
object[]

Array of associated legal or informational documents

client_account_id
string
read-only

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