API Reference
Entities
- The entity endpoint
- POSTCreate an Individual
- POSTCreate a Corporation
- PUTUpdate an Entity
- GETRetrieve an Entity
- GETList all Entities
- Connect
- Verification Sessions
- Credit Scores
- Attributes
- Vehicles
- Identities
- Products
- Subscriptions
- Consent
Accounts
- The account endpoint
- POSTCreate an Account
- GETRetrieve an Account
- GETList all Accounts
- Updates
- Transactions
- Card Brand
- Attributes
- Payoffs
- Balances
- Sensitive
- Payment Instruments
- Products
- Subscriptions
- Verification Sessions
- Consent
Payments
Supporting Endpoints
- Merchants
- Webhooks
- Reports
- Simulations (Dev)
- Health Check
The updates endpoint
{
"id": "upt_NYV5kfjskTTCJ",
"status": "completed",
"account_id": "acc_bFDiQGxiR8bqc",
"source": "direct",
"type": "credit_card",
"credit_card": {
"available_credit": 120000,
"balance": 80000,
"closed_at": null,
"credit_limit": 200000,
"interest_rate_percentage_max": 23.5,
"interest_rate_percentage_min": 12.0,
"interest_rate_type": "variable",
"last_payment_amount": 5000,
"last_payment_date": "2024-04-05",
"next_payment_due_date": "2024-05-01",
"next_payment_minimum_amount": 4000,
"opened_at": "2018-10-30",
"sub_type": "flexible_spending",
"usage_pattern": "transactor"
},
"data_as_of": "2024-03-20T04:43:21.434Z",
"error": null,
"created_at": "2024-03-20T04:43:21.434Z",
"updated_at": "2024-03-20T04:43:21.655Z"
}
The Updates endpoint retrieves in real-time account data including Balance, due dates, APRs, directly from the Account’s financial institution.
direct update coverage expands to 92% of all outstanding debt.The Updates endpoint is available as a:
| Type | Use-Case |
|---|---|
Product | On-Demand real-time account update (balance, due dates, etc) from the Account’s financial institution |
Subscription | Near real-time account update (balance, due dates, etc) from the Account’s financial institution. Webhook Payload |
Update Objects
Unique identifier for the Update.
The ID of the associated Account.
The source of the Update's data.
directUpdates received directly from the financial institution.
snapshotUpdates received from a monthly snapshot view from the financial institution.
Status of the Update.
pendingThe Update request is queued to be processed.
in_progressThe Update request is being processed.
completedThe Update request has successfully processed.
failedThe Update request failed processing.
The liability type of the Update's Account. See Account Liability Types.
Timestamp indicating when the data in this record was last known to be accurate.
An object representing an error that occurred while processing this Update. See Update errors.
Timestamp of when the Update was created.
Timestamp of when the Update was last updated.
Properties based on type
This object will be populated if the Update is of type credit_card.
The amount of credit currently available for use on this account.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
The maximum amount of credit that can be extended to the borrower on this account.
The maximum interest rate (variable) allowed for this account.
The minimum interest rate (variable) allowed for this account.
The liability interest rate type. One of fixed or variable
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
Sub-type of the credit card. One of flexible_spending, charge, secured, unsecured, purchase or business
Categorizes the usage behavior of the credit card holder.
transactorPays balances in full each month.
revolverCarries balances from month to month.
dormantAn inactive account with no recent transactions.
unknownUsage pattern is not determined or not available.
This object will be populated if the Update is of type credit_card.
The amount of credit currently available for use on this account.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
The maximum amount of credit that can be extended to the borrower on this account.
The maximum interest rate (variable) allowed for this account.
The minimum interest rate (variable) allowed for this account.
The liability interest rate type. One of fixed or variable
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
Sub-type of the credit card. One of flexible_spending, charge, secured, unsecured, purchase or business
Categorizes the usage behavior of the credit card holder.
transactorPays balances in full each month.
revolverCarries balances from month to month.
dormantAn inactive account with no recent transactions.
unknownUsage pattern is not determined or not available.
This object will be populated if the Update is of type mortgage.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
The anticipated date when the liability or loan will be fully paid off, formatted in ISO 8601 (YYYY-MM-DD).
The fixed interest rate for this account.
The liability interest rate source. One of financial_institution, public_data or method
The liability interest rate type. One of fixed or variable
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
The initial amount of money borrowed at the time the debt was issued.
Sub-type of the mortgage. Must be heloc
The duration of the loan or liability term, expressed in months.
This object will be populated if the Update is of type auto_loan.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
The anticipated date when the liability or loan will be fully paid off, formatted in ISO 8601 (YYYY-MM-DD).
The fixed interest rate for this account.
The liability interest rate source. One of financial_institution, public_data or method
The liability interest rate type. One of fixed or variable
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
The initial amount of money borrowed at the time the debt was issued.
Sub-type of the auto loan. One of lease or loan
The duration of the loan or liability term, expressed in months.
This object will be populated if the Update is of type personal_loan.
The amount of credit currently available for use on this account.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
The fixed interest rate for this account.
The liability interest rate source. One of financial_institution, public_data or method
The liability interest rate type. One of fixed or variable
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
The initial amount of money borrowed at the time the debt was issued.
Sub-type of the personal loan. One of secured, unsecured, heloc, line_of_credit or note
The duration of the loan or liability term, expressed in months.
This object will be populated if the Update is of type student_loans.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
A list of individual student loan disbursements.
The sequence number of this disbursement.
The current balance of this disbursement.
The amount of the last payment on this disbursement.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the disbursement was made, formatted in ISO 8601 (YYYY-MM-DD).
The fixed interest rate for this disbursement.
The maximum interest rate (variable) allowed for this disbursement.
The minimum interest rate (variable) allowed for this disbursement.
The type of interest rate for this disbursement. One of fixed or variable
The original loan amount for this disbursement.
The length of the term for this disbursement, in months.
The date when the disbursement was closed, if applicable, formatted in ISO 8601 (YYYY-MM-DD).
The source of the interest rate. One of financial_institution, public_data or method
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
The initial amount of money borrowed at the time the debt was issued.
Sub-type of the student loan. One of federal or private
The duration of the loan or liability term, expressed in months.
This object will be populated if the Update is of type bnpl.
This object will be populated if the Update is of type fintech.
Webhook Payload
The Webhook payload will contain the following information:
{
"id": "string",
"type": "update.create" | "update.update",
"path": "/accounts/<acc_id>/updates/<upt_id>",
}
{
"id": "upt_NYV5kfjskTTCJ",
"status": "completed",
"account_id": "acc_bFDiQGxiR8bqc",
"source": "direct",
"type": "credit_card",
"credit_card": {
"available_credit": 120000,
"balance": 80000,
"closed_at": null,
"credit_limit": 200000,
"interest_rate_percentage_max": 23.5,
"interest_rate_percentage_min": 12.0,
"interest_rate_type": "variable",
"last_payment_amount": 5000,
"last_payment_date": "2024-04-05",
"next_payment_due_date": "2024-05-01",
"next_payment_minimum_amount": 4000,
"opened_at": "2018-10-30",
"sub_type": "flexible_spending",
"usage_pattern": "transactor"
},
"data_as_of": "2024-03-20T04:43:21.434Z",
"error": null,
"created_at": "2024-03-20T04:43:21.434Z",
"updated_at": "2024-03-20T04:43:21.655Z"
}
{
"id": "upt_NYV5kfjskTTCJ",
"status": "completed",
"account_id": "acc_bFDiQGxiR8bqc",
"source": "direct",
"type": "credit_card",
"credit_card": {
"available_credit": 120000,
"balance": 80000,
"closed_at": null,
"credit_limit": 200000,
"interest_rate_percentage_max": 23.5,
"interest_rate_percentage_min": 12.0,
"interest_rate_type": "variable",
"last_payment_amount": 5000,
"last_payment_date": "2024-04-05",
"next_payment_due_date": "2024-05-01",
"next_payment_minimum_amount": 4000,
"opened_at": "2018-10-30",
"sub_type": "flexible_spending",
"usage_pattern": "transactor"
},
"data_as_of": "2024-03-20T04:43:21.434Z",
"error": null,
"created_at": "2024-03-20T04:43:21.434Z",
"updated_at": "2024-03-20T04:43:21.655Z"
}