The account endpoint
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
Unique identifier for the Account.
The ID of the Entity who is the legal holder of this Account.
Status of the Account.
The type of Account. A debt-type account (Credit Card, Mortgage, etc). Must be liability
Liability Account information
ID of the AccountVerificationSession record. .
A list of products that the Account has access to. See Product Names.
A list of products that the Account can have access to but is missing some requirements. See Product Names.
A list of products that the Account is subscribed to. See Subscription Names.
A list of products that the Account can enroll into a subscription with. See Subscription Names.
A list of products that the Account can subscribe to but is missing some requirements. See Subscription Names.
An object representing an error that occurred while processing this Account. See Account errors.
Additional data provided during creation. See metadata
Timestamp of when the Account was created.
Timestamp of when the Account was last updated.
Additional Properties based on liability type
ID of the Update record. .
ID of the Balance record. .
ID of the Payoff record. .
Account Liability Types
| Type | Description |
|---|---|
auto_loan | A financial obligation incurred when borrowing funds to purchase a vehicle, usually secured by the vehicle itself. |
collection | An account that reflects debts not paid on time, now handled by a third-party collection agency to recover the funds. |
credit_builder | A type of financial arrangement, typically a small loan or secured credit card, designed to help individuals establish or improve their credit history. |
credit_card | A revolving line of credit that allows the holder to make purchases or cash advances up to a certain limit, requiring regular payments. |
insurance | Financial protection against specific losses in exchange for premiums paid, not typically a liability unless premiums are unpaid. |
loan | Money borrowed that must be repaid with interest, can include various types such as personal, auto, or business loans. |
medical | Accounts representing charges for healthcare services, often resulting from treatments or procedures not fully covered by insurance. |
mortgage | A long-term loan secured by real estate property, used to purchase or refinance that property. |
personal_loan | An secured/unsecured loan taken out by individuals from a bank or other financial institution for personal use. |
student_loans | Loans issued for the purpose of financing postsecondary education, payable under terms agreed upon completion of study. |
utility | Bills 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>"
}