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

Liability

Additional Properties based on liability type

Auto Loan

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.
bnpl	Buy Now, Pay Later — a type of loan that lets the borrower make a purchase immediately and pay for it over time in installments.
fintech	An account facilitated by a financial technology (fintech) company acting as an intermediary between the borrower and a partner bank or lender.

Account Liability Sub-Types

Type	Subtypes
loan	business, unsecured
auto_loan	lease, loan
collection	-
mortgage	heloc
credit_card	business, charge, flexible_spending, secured
personal_loan	line_of_credit, heloc, purchase, lease, note, secured, unsecured
student_loans	private, federal
credit_builder	rent

Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "account.create" | "account.update" | "account.number.update",
  "path": "/accounts/<acc_id>",
  "event": "<evt_id>"
}

Liability

{
  "id": "acc_RGACQH7XdfYhC",
  "holder_id": "ent_HYmQrVrcJQBBQ",
  "status": "active",
  "type": "liability",
  "liability": {
    "mch_id": "mch_302086",
    "mask": "1580",
    "ownership": "primary",
    "fingerprint": "27d5c0ea28338619192076d150eb7b56c288f9a1",
    "type": "credit_card",
    "name": "Chase Sapphire Reserve Credit Card"
  },
  "latest_verification_session": "avf_tB9mpmew8FLit",
  "update": "upt_NYV5kfjskTTCJ",
  "balance": "bal_dGCCNWHMQYRay",
  "card_brand": "crd_eVRdjn4jsfk3e",
  "payment_instrument": "pmt_inst_pd788hPVhLT37",
  "attribute": "acc_attr_cWBKqwVP87kim",
  "products": ["balance", "card_brand", "update", "payment", "payment_instrument"],
  "restricted_products": ["attribute", "sensitive"],
  "subscriptions": [],
  "available_subscriptions": ["update.snapshot", "update"],
  "restricted_subscriptions": ["transaction"],
  "error": null,
  "metadata": null,
  "created_at": "2024-02-12T18:57:57.857Z",
  "updated_at": "2024-03-20T04:43:21.655Z",
}