Skip to main content
GET
Retrieve Account

Authorizations

Authorization
string
header
required

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

Headers

Accept-Encoding
string

We can compress a response with gzip.

Example:

"gzip deflate"

API-Version
string

API API Version. See Versioning page for more details.

Example:

"2024-07-01"

Path Parameters

id
integer
required

An userId.

Example:

1

account_id
integer
required

An accountId.

Example:

1

Response

Returns information about an account

id
integer
required

Account ID

Example:

1

name
string
required

Account's name

Example:

"JCP Morgan"

type
enum<string>
required

Account's type

Available options:
depository,
loan,
investment,
other
Example:

"loan"

subtype
enum<string> | null
required

Account's sub type, which indicates which the account type

Available options:
student_loan,
credit_card_loan,
auto_loan,
personal_loan,
mortgage_loan,
medical_loan,
other_loan,
checking,
savings
Example:

"credit_card_loan"

mask
string
required

Account's mask, or the last 4 digits of the account number

Required string length: 4
Example:

"1234"

status
enum<string>
required

Account's status

Available options:
active,
disabled,
closed
Example:

"active"

nickname
string | null

User's nickname for account

Example:

"Primary credit card"

user_apr
number | null

User's APR for account

Example:

5.5

user_minimum_payment
integer | null

User's minimum payment for account in cents

Example:

10000

effective_minimum_payment
integer | null

Account minimum payment in cents

Example:

15000

effective_apr
number | null

Account's APR

Example:

6.3

original_loan_amount
integer | null

Original loan amount in cents

Example:

15000000

balance
integer | null

Balance of account in cents

Example:

150000

limit
integer | null

Maximum limit of account in cents

Example:

0

last_payment_amount
integer | null

Last payment amount for the loan in cents

Example:

20000

last_updated_at
string | null

Last data sync for account date

Example:

"2024-06-01"

last_payment_date
string | null

Last payment date

Example:

"2024-05-25"

opened_at
string | null

Date when account was opened

Example:

"2024-05-25"

closed_at
string | null

Date when account was closed

Example:

"2024-05-25"

institution_name
string | null

Account's Institution name

Example:

"Chase"

institution_logo
string | null

Base 64 encoded image

next_payment_due_date
string | null

Next payment date

Example:

"2024-06-25"

user_next_payment_date
string | null

User's custom next payment date

Example:

"2024-06-25"

first_time_payment
boolean | null

Indicates if next payment will be the first

Example:

false

expected_payoff_date
string | null

Indicates account's close date if minimum payment will be paid off

Example:

"2052-01-01"

payments_history
enum<string>[]

24 months payment history, where each string represents monthly payment status: "0" = The account is too new to rate, or has been approved, but not yet used; "1" = Payments have been made on-time; "2" = Two or fewer payments are past due; "3" = Three or fewer payments are past due; "4" = Four or fewer payments are past due; "5" = Either more than four payments are past due, or least one payment is more than 120 days past due; "6" = The account is with collections (Enhanced Trade Only); "7" = Included in Chapter 13; "8" = Repossession; "9" = Charge-off; "E" = The account has a zero balance or is current; "*" = Payment status was not available; Blank = Not reported;

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
,
E,
*