Skip to main content
GET
Get an account by external contract ID

Authorizations

Authorization
string
header
required

Short-lived access token minted by POST /v1/oauth/token.

Path Parameters

external_contract_id
string
required

Query Parameters

organization_id
string | null

Optional organization used to disambiguate reused identifiers.

Response

Successful Response

Detailed account snapshot with contract and borrower relationships.

id
string
required
organization_id
string
required

The organization the account belongs to.

contract_id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
contract
ContractSummary · object
required

Originated-loan facts. Returned nested on AccountDetailRow.

external_id
string | null

Source loan-management account identifier.

external_contract_id
string | null

Client-supplied contract identifier.

status_code
string | null

Current account status code.

current_balance_cents
integer | null

Current outstanding balance in cents.

past_due_amount_cents
integer | null

Amount currently past due in cents.

payoff_amount_cents
integer | null

Current payoff amount in cents.

payment_amount_cents
integer | null

Scheduled payment amount in cents.

payment_frequency
string | null

Scheduled payment cadence.

last_payment_at
string<date> | null

Date of the most recent payment.

next_payment_due_at
string<date> | null

Next scheduled payment due date.

payments_made
integer | null
interest_rate_bps
integer | null

Annual interest rate in basis points.

apr_bps
integer | null

Annual percentage rate in basis points.

interest_start_at
string<date> | null
days_past_due_30
integer | null

Days in the 1-30 day delinquency bucket.

days_past_due_60
integer | null

Days in the 31-60 day delinquency bucket.

days_past_due_90
integer | null

Days in the 61-90 day delinquency bucket.

nsf_count
integer | null

Number of non-sufficient-funds events.

opened_at
string<date> | null

Date the account opened.

closed_at
string<date> | null

Date the account closed, when applicable.

borrowers
AccountBorrowerDetail · object[]

Enriched borrower parties, with the primary borrower first.

accrued_interest_cents
integer | null

Accrued unbilled interest in cents.

accrued_late_charge_cents
integer | null

Accrued late charges in cents.

last_payment_amount_cents
integer | null

Most recent payment amount in cents.

first_payment_made_at
string<date> | null

Date the first payment was received.

final_payment_amount_cents
integer | null

Scheduled final payment in cents.

last_extension_at
string<date> | null

Date of the most recent term extension.

interest_base_days
integer | null

Interest day-count convention.

over_short_cents
integer | null

Over/short adjustment balance in cents.