Accounts are a representation of an Entity’s financial accounts. An Account can be a checking or savings account (ACH) or a credit card, student loan, mortgage, personal loan, etc. (Liability).

​
Account Objects

id
string

Unique identifier for the Account.

holder_id
string

The ID of the Entity who is the legal holder of this Account.

status
enum

Status of the Account.

type
enum

The type of Account. A debt-type account (Credit Card, Mortgage, etc). Must be liability

liability
object | null

Liability Account information

latest_verification_session
string | null

ID of the AccountVerificationSession record. .

products
string[]

A list of products that the Account has access to. See Product Names.

restricted_products
string[]

A list of products that the Account can have access to but is missing some requirements. See Product Names.

subscriptions
string[]

A list of products that the Account is subscribed to. See Subscription Names.

available_subscriptions
string[]

A list of products that the Account can enroll into a subscription with. See Subscription Names.

restricted_subscriptions
string[]

A list of products that the Account can subscribe to but is missing some requirements. See Subscription Names.

error
object | null

An object representing an error that occurred while processing this Account. See Account errors.

metadata
object | null

Additional data provided during creation. See metadata

created_at
string

Timestamp of when the Account was created.

updated_at
string

Timestamp of when the Account was last updated.

Additional Properties based on liability type

update
string | null

ID of the Update record. .

balance
string | null

ID of the Balance record. .

payoff
string | null

ID of the Payoff record. .

​
Account Liability Types

TypeDescription
auto_loanA financial obligation incurred when borrowing funds to purchase a vehicle, usually secured by the vehicle itself.
collectionAn account that reflects debts not paid on time, now handled by a third-party collection agency to recover the funds.
credit_builderA type of financial arrangement, typically a small loan or secured credit card, designed to help individuals establish or improve their credit history.
credit_cardA revolving line of credit that allows the holder to make purchases or cash advances up to a certain limit, requiring regular payments.
insuranceFinancial protection against specific losses in exchange for premiums paid, not typically a liability unless premiums are unpaid.
loanMoney borrowed that must be repaid with interest, can include various types such as personal, auto, or business loans.
medicalAccounts representing charges for healthcare services, often resulting from treatments or procedures not fully covered by insurance.
mortgageA long-term loan secured by real estate property, used to purchase or refinance that property.
personal_loanAn secured/unsecured loan taken out by individuals from a bank or other financial institution for personal use.
student_loansLoans issued for the purpose of financing postsecondary education, payable under terms agreed upon completion of study.
utilityBills owed for basic services such as electricity, water, and gas, which if unpaid, can become delinquent liabilities.

​
Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "account.create" | "account.update",
  "path": "/accounts/<acc_id>",
  "event": "<evt_id>"
}
Withdraw an Entity's ConsentCreate an Account