Identity
API reference for Identity endpoints and webhooks
Verify the name, address, phone number, and email address of a user against bank account information on file.
| Endpoints | |
|---|---|
/identity/get | Fetch identity data |
/identity/match | Match client identity with bank identity |
/identity/documents/uploads/get | Get Identity data parsed from an uploaded bank statement |
Endpoints
/identity/get
Retrieve identity data
The /identity/get endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.
Note: In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see Plaid API versioning.
Request fields
client_idstring
Your Plaid API
client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.secretstring
Your Plaid API
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.access_tokenrequiredstring
The access token associated with the Item data is being requested for.
optionsobject
An optional object to filter
/identity/get results.account_ids[string]
A list of
account_ids to retrieve for the Item.
Note: An error will be returned if a provided account_id is not associated with the Item.Select group for content switcher
1// Pull Identity data for an Item2const request: IdentityGetRequest = {3 access_token: accessToken,4};5try {6 const response = await plaidClient.identityGet(request);7 const identities = response.data.accounts.flatMap(8 (account) => account.owners,9 );10} catch (error) {11 // handle error12}identity/get
See the Account type schema for a full listing of account types and corresponding subtypes.
Response fields and example
accounts[object]
The accounts for which Identity data has been requested
account_idstring
Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new
The
If an account with a specific
Like all Plaid identifiers, the
account_id will be assigned to the account.The
account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.If an account with a specific
account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.Like all Plaid identifiers, the
account_id is case sensitive.balancesobject
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by
/accounts/balance/get.availablenullablenumber
The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For
For
For
Note that not all institutions calculate the
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
If
For
credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.For
depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.For
investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.Note that not all institutions calculate the
available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
/accounts/balance/get.If
current is null this field is guaranteed not to be null.Format:
double currentnullablenumber
The total amount of funds in or owed by the account.
For
For
For
Note that balance information may be cached unless the value was returned by
When returned by
For
credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.For
loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.For
investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.Note that balance information may be cached unless the value was returned by
/accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.When returned by
/accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.Format:
double limitnullablenumber
For
For
In North America, this field is typically only available for
credit-type accounts, this represents the credit limit.For
depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.In North America, this field is typically only available for
credit-type accounts.Format:
double iso_currency_codenullablestring
The ISO-4217 currency code of the balance. Always null if
unofficial_currency_code is non-null.unofficial_currencynullablestring
The unofficial currency code associated with the balance. Always null if
See the currency code schema for a full listing of supported
iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.See the currency code schema for a full listing of supported
unofficial_currency_codes.last_updated_datetimenullablestring
Timestamp in ISO 8601 format (
This field is only used and expected when the institution is
If the balance that is pulled is older than the given timestamp for Items with this field required, an
YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.This field is only used and expected when the institution is
ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.Format:
date-time masknullablestring
The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
namestring
The name of the account, either assigned by the user or by the financial institution itself
official_namenullablestring
The official name of the account as given by the financial institution
typestring
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.credit: Credit carddepository: Depository accountloan: Loan accountother: Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
Possible values:
investment, credit, depository, loan, brokerage, othersubtypenullablestring
See the Account type schema for a full listing of account types and corresponding subtypes.
Possible values:
401a, 401k, 403B, 457b, 529, auto, brokerage, business, cash isa, cash management, cd, checking, commercial, construction, consumer, credit card, crypto exchange, ebt, education savings account, fixed annuity, gic, health reimbursement arrangement, home equity, hsa, isa, ira, keogh, lif, life insurance, line of credit, lira, loan, lrif, lrsp, money market, mortgage, mutual fund, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, overdraft, paypal, payroll, pension, prepaid, prif, profit sharing plan, rdsp, resp, retirement, rlif, roth, roth 401k, rrif, rrsp, sarsep, savings, sep ira, simple ira, sipp, stock plan, student, thrift savings plan, tfsa, trust, ugma, utma, variable annuityverification_statusstring
The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verificationpending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.automatically_verified: The Item has successfully been automatically verified manually_verified: The Item has successfully been manually verifiedverification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.database_matched: The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match.database_insights_pass: The Item's numbers have been verified using Plaid's data sources and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_fail: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.Possible values:
automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_failverification_insightsobject
Insights from performing database verification for the account. Only returned for Auth Items created via Database Insights.
network_statusobject
Status information about the account and routing number in the Plaid network.
has_numbers_matchboolean
Indicates whether we found at least one matching account for the ACH account and routing number.
is_numbers_matchboolean
Indicates if at least one matching account for the ACH account and routing number is already verified.
previous_returnsobject
Information about known ACH returns for the account and routing number.
has_previousboolean
Indicates whether Plaid's data sources include a known administrative ACH return for account and routing number.
account_number_formatstring
Indicator of account number format validity for institution.
valid: indicates that the account number has a correct format for the institution.invalid: indicates that the account number has an incorrect format for the institution.unknown: indicates that there was not enough information to determine whether the format is correct for the institution.Possible values:
valid, invalid, unknownpersistent_account_idstring
A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field may be populated for any account; in Production, it will only be populated for accounts at applicable institutions.
holder_categorynullablestring
Indicates the account's categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.
Possible values:
business, personal, unrecognizedowners[object]
Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution; detecting whether the linked account is a business account is not currently supported. Multiple owners on a single account will be represented in the same
owner object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see Plaid API versioningnames[string]
A list of names associated with the account by the financial institution. In the case of a joint account, Plaid will make a best effort to report the names of all account holders.
If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's
If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's
names array.phone_numbers[object]
A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
emails[object]
A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
addresses[object]
Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
dataobject
Data about the components comprising an address.
citynullablestring
The full city name
regionnullablestring
The region or state. In API versions 2018-05-22 and earlier, this field is called
state.
Example: "NC"streetstring
The full street address
Example:
"564 Main Street, APT 15"postal_codenullablestring
The postal code. In API versions 2018-05-22 and earlier, this field is called
zip.countrynullablestring
The ISO 3166-1 alpha-2 country code
primaryboolean
When
true, identifies the address as the primary address on an account.itemobject
Metadata about the Item.
item_idstring
The Plaid Item ID. The
item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.institution_idnullablestring
The Plaid Institution ID associated with the Item. Field is
null for Items created via Same Day Micro-deposits.webhooknullablestring
The URL registered to receive webhooks for the Item.
errornullableobject
Errors are identified by
error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.error_typestring
A broad categorization of the error. Safe for programmatic use.
Possible values:
INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR, SANDBOX_ERROR, PARTNER_ERROR, TRANSACTIONS_ERROR, TRANSACTION_ERROR, TRANSFER_ERRORerror_codestring
The particular error code. Safe for programmatic use.
error_code_reasonnullablestring
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors;
Possible values:
null will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_messagestring
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagenullablestring
A user-friendly representation of the error code.
This may change over time and is not safe for programmatic use.
null if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_idstring
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarray
In this product, a request can pertain to more than one Item. If an error is returned for such a request,
causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.statusnullableinteger
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstring
The URL of a Plaid documentation page with more information about the error
suggested_actionnullablestring
Suggested steps for resolving the error
available_products[string]
A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with
billed_products.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankbilled_products[string]
A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with
available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankproducts[string]
A list of products added to the Item. In almost all cases, this will be the same as the
billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankconsented_products[string]
A list of products that the user has consented to for the Item via Data Transparency Messaging. This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product.
Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, transactions, income, income_verification, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, cra_base_report, cra_income_insights, cra_partner_insights, cra_cashflow_insights, layerconsent_expirationnullablestring
The date and time at which the Item's access consent will expire, in ISO 8601 format
Format:
date-time update_typestring
Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
background - Item can be updated in the backgrounduser_present_required - Item requires user interaction to be updatedPossible values:
background, user_present_requiredrequest_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "accounts": [3 {4 "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",5 "balances": {6 "available": 100,7 "current": 110,8 "iso_currency_code": "USD",9 "limit": null,10 "unofficial_currency_code": null11 },12 "mask": "0000",13 "name": "Plaid Checking",14 "official_name": "Plaid Gold Standard 0% Interest Checking",15 "owners": [16 {17 "addresses": [18 {19 "data": {20 "city": "Malakoff",21 "country": "US",22 "postal_code": "14236",23 "region": "NY",24 "street": "2992 Cameron Road"25 },26 "primary": true27 },28 {29 "data": {30 "city": "San Matias",31 "country": "US",32 "postal_code": "93405-2255",33 "region": "CA",34 "street": "2493 Leisure Lane"35 },36 "primary": false37 }38 ],39 "emails": [40 {41 "data": "accountholder0@example.com",42 "primary": true,43 "type": "primary"44 },45 {46 "data": "accountholder1@example.com",47 "primary": false,48 "type": "secondary"49 },50 {51 "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",52 "primary": false,53 "type": "other"54 }55 ],56 "names": [57 "Alberta Bobbeth Charleson"58 ],59 "phone_numbers": [60 {61 "data": "1112223333",62 "primary": false,63 "type": "home"64 },65 {66 "data": "1112224444",67 "primary": false,68 "type": "work"69 },70 {71 "data": "1112225555",72 "primary": false,73 "type": "mobile"74 }75 ]76 }77 ],78 "subtype": "checking",79 "type": "depository"80 },81 {82 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",83 "balances": {84 "available": 200,85 "current": 210,86 "iso_currency_code": "USD",87 "limit": null,88 "unofficial_currency_code": null89 },90 "mask": "1111",91 "name": "Plaid Saving",92 "official_name": "Plaid Silver Standard 0.1% Interest Saving",93 "owners": [94 {95 "addresses": [96 {97 "data": {98 "city": "Malakoff",99 "country": "US",100 "postal_code": "14236",101 "region": "NY",102 "street": "2992 Cameron Road"103 },104 "primary": true105 },106 {107 "data": {108 "city": "San Matias",109 "country": "US",110 "postal_code": "93405-2255",111 "region": "CA",112 "street": "2493 Leisure Lane"113 },114 "primary": false115 }116 ],117 "emails": [118 {119 "data": "accountholder0@example.com",120 "primary": true,121 "type": "primary"122 },123 {124 "data": "accountholder1@example.com",125 "primary": false,126 "type": "secondary"127 },128 {129 "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",130 "primary": false,131 "type": "other"132 }133 ],134 "names": [135 "Alberta Bobbeth Charleson"136 ],137 "phone_numbers": [138 {139 "data": "1112223333",140 "primary": false,141 "type": "home"142 },143 {144 "data": "1112224444",145 "primary": false,146 "type": "work"147 },148 {149 "data": "1112225555",150 "primary": false,151 "type": "mobile"152 }153 ]154 }155 ],156 "subtype": "savings",157 "type": "depository"158 }159 ],160 "item": {161 "available_products": [162 "balance",163 "investments"164 ],165 "billed_products": [166 "assets",167 "auth",168 "identity",169 "liabilities",170 "transactions"171 ],172 "consent_expiration_time": null,173 "error": null,174 "institution_id": "ins_3",175 "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",176 "update_type": "background",177 "webhook": "https://www.genericwebhookurl.com/webhook"178 },179 "request_id": "3nARps6TOYtbACO"180}Was this helpful?
/identity/match
Retrieve identity match score
The /identity/match endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.
Fields within the balances object will always be null when retrieved by /identity/match. Instead, use the free /accounts/get endpoint to request balance cached data, or /accounts/balance/get for real-time data.
Request fields
client_idstring
Your Plaid API
client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.secretstring
Your Plaid API
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.access_tokenrequiredstring
The access token associated with the Item data is being requested for.
userobject
The user's legal name, phone number, email address and address used to perform fuzzy match. If Financial Account Matching is enabled in the Identity Verification product, leave this field empty to automatically match against PII collected from the Identity Verification checks.
legal_namestring
The user's full legal name.
phone_numberstring
The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment.
email_addressstring
The user's email address.
addressobject
Data about the components comprising an address.
citystring
The full city name
regionstring
The region or state. In API versions 2018-05-22 and earlier, this field is called
state.
Example: "NC"streetstring
The full street address
Example:
"564 Main Street, APT 15"postal_codestring
The postal code. In API versions 2018-05-22 and earlier, this field is called
zip.countrystring
The ISO 3166-1 alpha-2 country code
optionsobject
An optional object to filter /identity/match results
account_ids[string]
An array of
account_ids to perform fuzzy match1// Match identity provided by client against bank/account identity2const request = {3 access_token: accessToken,4};56try {7 const response = await plaidClient.identityMatch(request);8 const accounts = response.data.accounts;9 for (var account of accounts) {10 const legalNameScore = account.legal_name?.score;11 const phoneScore = account.phone_number?.score;12 const emailScore = account.email_address?.score;13 const addressScore = account.address?.score;14 }15} catch (error) {16 // handle error17}identity/match
See the Account type schema for a full listing of account types and corresponding subtypes.
Response fields and example
accounts[object]
The accounts for which Identity match has been requested
account_idstring
Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new
The
If an account with a specific
Like all Plaid identifiers, the
account_id will be assigned to the account.The
account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.If an account with a specific
account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.Like all Plaid identifiers, the
account_id is case sensitive.balancesobject
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by
/accounts/balance/get.availablenullablenumber
The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For
For
For
Note that not all institutions calculate the
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
If
For
credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.For
depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.For
investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.Note that not all institutions calculate the
available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
/accounts/balance/get.If
current is null this field is guaranteed not to be null.Format:
double currentnullablenumber
The total amount of funds in or owed by the account.
For
For
For
Note that balance information may be cached unless the value was returned by
When returned by
For
credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.For
loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.For
investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.Note that balance information may be cached unless the value was returned by
/accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.When returned by
/accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.Format:
double limitnullablenumber
For
For
In North America, this field is typically only available for
credit-type accounts, this represents the credit limit.For
depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.In North America, this field is typically only available for
credit-type accounts.Format:
double iso_currency_codenullablestring
The ISO-4217 currency code of the balance. Always null if
unofficial_currency_code is non-null.unofficial_currencynullablestring
The unofficial currency code associated with the balance. Always null if
See the currency code schema for a full listing of supported
iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.See the currency code schema for a full listing of supported
unofficial_currency_codes.last_updated_datetimenullablestring
Timestamp in ISO 8601 format (
This field is only used and expected when the institution is
If the balance that is pulled is older than the given timestamp for Items with this field required, an
YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.This field is only used and expected when the institution is
ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.Format:
date-time masknullablestring
The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
namestring
The name of the account, either assigned by the user or by the financial institution itself
official_namenullablestring
The official name of the account as given by the financial institution
typestring
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.credit: Credit carddepository: Depository accountloan: Loan accountother: Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
Possible values:
investment, credit, depository, loan, brokerage, othersubtypenullablestring
See the Account type schema for a full listing of account types and corresponding subtypes.
Possible values:
401a, 401k, 403B, 457b, 529, auto, brokerage, business, cash isa, cash management, cd, checking, commercial, construction, consumer, credit card, crypto exchange, ebt, education savings account, fixed annuity, gic, health reimbursement arrangement, home equity, hsa, isa, ira, keogh, lif, life insurance, line of credit, lira, loan, lrif, lrsp, money market, mortgage, mutual fund, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, overdraft, paypal, payroll, pension, prepaid, prif, profit sharing plan, rdsp, resp, retirement, rlif, roth, roth 401k, rrif, rrsp, sarsep, savings, sep ira, simple ira, sipp, stock plan, student, thrift savings plan, tfsa, trust, ugma, utma, variable annuityverification_statusstring
The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verificationpending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.automatically_verified: The Item has successfully been automatically verified manually_verified: The Item has successfully been manually verifiedverification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.database_matched: The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match.database_insights_pass: The Item's numbers have been verified using Plaid's data sources and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_fail: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.Possible values:
automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_failverification_insightsobject
Insights from performing database verification for the account. Only returned for Auth Items created via Database Insights.
network_statusobject
Status information about the account and routing number in the Plaid network.
has_numbers_matchboolean
Indicates whether we found at least one matching account for the ACH account and routing number.
is_numbers_matchboolean
Indicates if at least one matching account for the ACH account and routing number is already verified.
previous_returnsobject
Information about known ACH returns for the account and routing number.
has_previousboolean
Indicates whether Plaid's data sources include a known administrative ACH return for account and routing number.
account_number_formatstring
Indicator of account number format validity for institution.
valid: indicates that the account number has a correct format for the institution.invalid: indicates that the account number has an incorrect format for the institution.unknown: indicates that there was not enough information to determine whether the format is correct for the institution.Possible values:
valid, invalid, unknownpersistent_account_idstring
A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field may be populated for any account; in Production, it will only be populated for accounts at applicable institutions.
holder_categorynullablestring
Indicates the account's categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.
Possible values:
business, personal, unrecognizedlegal_namenullableobject
Score found by matching name provided by the API with the name on the account at the financial institution. If the account contains multiple owners, the maximum match score is filled.
scorenullableinteger
Match score for name. 100 is a perfect score, 99-85 means a strong match, 84-70 is a partial match, any score less than 70 is a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the name is missing from either the API or financial institution, this is null.
is_first_name_or_lastnullableboolean
first or last name completely matched, likely a family member
is_nickname_matchnullableboolean
nickname matched, example Jennifer and Jenn.
is_business_namenullableboolean
Is
true if the name on either of the names that was matched for the score contained strings indicative of a business name, such as "CORP", "LLC", "INC", or "LTD". A true result generally indicates that an account's name is a business name. However, a false result does not mean the account name is not a business name, as some businesses do not use these strings in the names used for their financial institution accounts.phone_numbernullableobject
Score found by matching phone number provided by the API with the phone number on the account at the financial institution. 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.
scorenullableinteger
Match score for normalized phone number. 100 is a perfect match, 99-70 is a partial match (matching the same phone number with extension against one without extension, etc.), anything below 70 is considered a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the phone number is missing from either the API or financial institution, this is null.
email_addressnullableobject
Score found by matching email provided by the API with the email on the account at the financial institution. 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.
scorenullableinteger
Match score for normalized email. 100 is a perfect match, 99-70 is a partial match (matching the same email with different '+' extensions), anything below 70 is considered a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the email is missing from either the API or financial institution, this is null.
addressnullableobject
Score found by matching address provided by the API with the address on the account at the financial institution. The score can range from 0 to 100 where 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.
scorenullableinteger
Match score for address. 100 is a perfect match, 99-90 is a strong match, 89-70 is a partial match, anything below 70 is considered a weak match. Typically, the match threshold should be set to a score of 70 or higher. If the address is missing from either the API or financial institution, this is null.
is_postal_code_matchnullableboolean
postal code was provided for both and was a match
itemobject
Metadata about the Item.
item_idstring
The Plaid Item ID. The
item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.institution_idnullablestring
The Plaid Institution ID associated with the Item. Field is
null for Items created via Same Day Micro-deposits.webhooknullablestring
The URL registered to receive webhooks for the Item.
errornullableobject
Errors are identified by
error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.error_typestring
A broad categorization of the error. Safe for programmatic use.
Possible values:
INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR, SANDBOX_ERROR, PARTNER_ERROR, TRANSACTIONS_ERROR, TRANSACTION_ERROR, TRANSFER_ERRORerror_codestring
The particular error code. Safe for programmatic use.
error_code_reasonnullablestring
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors;
Possible values:
null will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_messagestring
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagenullablestring
A user-friendly representation of the error code.
This may change over time and is not safe for programmatic use.
null if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_idstring
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarray
In this product, a request can pertain to more than one Item. If an error is returned for such a request,
causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.statusnullableinteger
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstring
The URL of a Plaid documentation page with more information about the error
suggested_actionnullablestring
Suggested steps for resolving the error
available_products[string]
A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with
billed_products.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankbilled_products[string]
A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with
available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankproducts[string]
A list of products added to the Item. In almost all cases, this will be the same as the
billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankconsented_products[string]
A list of products that the user has consented to for the Item via Data Transparency Messaging. This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product.
Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, transactions, income, income_verification, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, cra_base_report, cra_income_insights, cra_partner_insights, cra_cashflow_insights, layerconsent_expirationnullablestring
The date and time at which the Item's access consent will expire, in ISO 8601 format
Format:
date-time update_typestring
Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
background - Item can be updated in the backgrounduser_present_required - Item requires user interaction to be updatedPossible values:
background, user_present_requiredrequest_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "accounts": [3 {4 "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",5 "balances": {6 "available": null,7 "current": null,8 "iso_currency_code": null,9 "limit": null,10 "unofficial_currency_code": null11 },12 "mask": "0000",13 "name": "Plaid Checking",14 "official_name": "Plaid Gold Standard 0% Interest Checking",15 "legal_name": {16 "score": 90,17 "is_nickname_match": true,18 "is_first_name_or_last_name_match": true,19 "is_business_name_detected": false20 },21 "phone_number": {22 "score": 10023 },24 "email_address": {25 "score": 10026 },27 "address": {28 "score": 100,29 "is_postal_code_match": true30 },31 "subtype": "checking",32 "type": "depository"33 },34 {35 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",36 "balances": {37 "available": null,38 "current": null,39 "iso_currency_code": null,40 "limit": null,41 "unofficial_currency_code": null42 },43 "mask": "1111",44 "name": "Plaid Saving",45 "official_name": "Plaid Silver Standard 0.1% Interest Saving",46 "legal_name": {47 "score": 30,48 "is_first_name_or_last_name_match": false49 },50 "phone_number": {51 "score": 10052 },53 "email_address": null,54 "address": {55 "score": 100,56 "is_postal_code_match": true57 },58 "subtype": "savings",59 "type": "depository"60 }61 ],62 "item": {63 "available_products": [64 "balance",65 "investments"66 ],67 "billed_products": [68 "assets",69 "auth",70 "identity",71 "liabilities",72 "transactions"73 ],74 "consent_expiration_time": null,75 "error": null,76 "institution_id": "ins_3",77 "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",78 "update_type": "background",79 "webhook": "https://www.genericwebhookurl.com/webhook"80 },81 "request_id": "3nARps6TOYtbACO"82}Was this helpful?
/identity/documents/uploads/get
Returns uploaded document identity
Use /identity/documents/uploads/get to retrieve identity details when using Identity Document Upload.
Request fields
client_idstring
Your Plaid API
client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.secretstring
Your Plaid API
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.access_tokenrequiredstring
The access token associated with the Item data is being requested for.
optionsobject
An optional object to filter
/identity/documents/uploads/get results.account_ids[string]
A list of
account_ids to retrieve for the Item.
Note: An error will be returned if a provided account_id is not associated with the Item.1const request: IdentityDocumentsUploadsGetRequest = {2 access_token: accessToken,3};4try {5 const response = await client.identityDocumentsUploadsGet(request);6} catch (error) {7 // handle error8}identity/documents/uploads/get
See the Account type schema for a full listing of account types and corresponding subtypes.
Response fields and example
accounts[object]
The accounts for which Identity data has been requested
account_idstring
Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new
The
If an account with a specific
Like all Plaid identifiers, the
account_id will be assigned to the account.The
account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.If an account with a specific
account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.Like all Plaid identifiers, the
account_id is case sensitive.balancesobject
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by
/accounts/balance/get.availablenullablenumber
The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For
For
For
Note that not all institutions calculate the
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
If
For
credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.For
depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.For
investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.Note that not all institutions calculate the
available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
/accounts/balance/get.If
current is null this field is guaranteed not to be null.Format:
double currentnullablenumber
The total amount of funds in or owed by the account.
For
For
For
Note that balance information may be cached unless the value was returned by
When returned by
For
credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.For
loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.For
investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.Note that balance information may be cached unless the value was returned by
/accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.When returned by
/accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.Format:
double limitnullablenumber
For
For
In North America, this field is typically only available for
credit-type accounts, this represents the credit limit.For
depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.In North America, this field is typically only available for
credit-type accounts.Format:
double iso_currency_codenullablestring
The ISO-4217 currency code of the balance. Always null if
unofficial_currency_code is non-null.unofficial_currencynullablestring
The unofficial currency code associated with the balance. Always null if
See the currency code schema for a full listing of supported
iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.See the currency code schema for a full listing of supported
unofficial_currency_codes.last_updated_datetimenullablestring
Timestamp in ISO 8601 format (
This field is only used and expected when the institution is
If the balance that is pulled is older than the given timestamp for Items with this field required, an
YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.This field is only used and expected when the institution is
ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.Format:
date-time masknullablestring
The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
namestring
The name of the account, either assigned by the user or by the financial institution itself
official_namenullablestring
The official name of the account as given by the financial institution
typestring
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.credit: Credit carddepository: Depository accountloan: Loan accountother: Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
Possible values:
investment, credit, depository, loan, brokerage, othersubtypenullablestring
See the Account type schema for a full listing of account types and corresponding subtypes.
Possible values:
401a, 401k, 403B, 457b, 529, auto, brokerage, business, cash isa, cash management, cd, checking, commercial, construction, consumer, credit card, crypto exchange, ebt, education savings account, fixed annuity, gic, health reimbursement arrangement, home equity, hsa, isa, ira, keogh, lif, life insurance, line of credit, lira, loan, lrif, lrsp, money market, mortgage, mutual fund, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, overdraft, paypal, payroll, pension, prepaid, prif, profit sharing plan, rdsp, resp, retirement, rlif, roth, roth 401k, rrif, rrsp, sarsep, savings, sep ira, simple ira, sipp, stock plan, student, thrift savings plan, tfsa, trust, ugma, utma, variable annuityverification_statusstring
The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verificationpending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.automatically_verified: The Item has successfully been automatically verified manually_verified: The Item has successfully been manually verifiedverification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.database_matched: The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match.database_insights_pass: The Item's numbers have been verified using Plaid's data sources and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_fail: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.Possible values:
automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_failverification_insightsobject
Insights from performing database verification for the account. Only returned for Auth Items created via Database Insights.
network_statusobject
Status information about the account and routing number in the Plaid network.
has_numbers_matchboolean
Indicates whether we found at least one matching account for the ACH account and routing number.
is_numbers_matchboolean
Indicates if at least one matching account for the ACH account and routing number is already verified.
previous_returnsobject
Information about known ACH returns for the account and routing number.
has_previousboolean
Indicates whether Plaid's data sources include a known administrative ACH return for account and routing number.
account_number_formatstring
Indicator of account number format validity for institution.
valid: indicates that the account number has a correct format for the institution.invalid: indicates that the account number has an incorrect format for the institution.unknown: indicates that there was not enough information to determine whether the format is correct for the institution.Possible values:
valid, invalid, unknownpersistent_account_idstring
A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field may be populated for any account; in Production, it will only be populated for accounts at applicable institutions.
holder_categorynullablestring
Indicates the account's categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.
Possible values:
business, personal, unrecognizedowners[object]
Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution; detecting whether the linked account is a business account is not currently supported. Multiple owners on a single account will be represented in the same
owner object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see Plaid API versioningnames[string]
A list of names associated with the account by the financial institution. In the case of a joint account, Plaid will make a best effort to report the names of all account holders.
If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's
If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's
names array.phone_numbers[object]
A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
emails[object]
A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
addresses[object]
Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
dataobject
Data about the components comprising an address.
citynullablestring
The full city name
regionnullablestring
The region or state. In API versions 2018-05-22 and earlier, this field is called
state.
Example: "NC"streetstring
The full street address
Example:
"564 Main Street, APT 15"postal_codenullablestring
The postal code. In API versions 2018-05-22 and earlier, this field is called
zip.countrynullablestring
The ISO 3166-1 alpha-2 country code
primaryboolean
When
true, identifies the address as the primary address on an account.documentsnullable[object]
Data about the documents that were uploaded as proof of account ownership.
document_idstring
A UUID identifying the document.
metadataobject
Metadata pertaining to the document.
document_typenullablestring
The submitted document type. Currently, this will always be
BANK_STATEMENT.is_account_numbernullableboolean
Boolean field indicating whether the uploaded document's account number matches the account number we have on file. If
false, it is not recommended to accept the uploaded identity data as accurate without further verification.page_countnullableinteger
The number of pages in the uploaded document.
last_updatedstring
The timestamp when the document was last updated.
Format:
date-time uploaded_atstring
The timestamp when the document was originally uploaded.
Format:
date-time risk_insightsobject
Object representing fraud risk data of the uploaded document. Only provided when using Identity Document Upload with Fraud Risk enabled.
risk_summaryobject
Risk summary of an uploaded document.
risk_scorenullableinteger
A number between 0 and 100, inclusive, where a score closer to 0 indicates a document is likely to be trustworthy and a score closer to 100 indicates a document is likely to be fraudulent.
risk_signals[object]
An array of risk signals.
typenullablestring
The type of risk found.
Possible values:
FONT, MASKING, OVERLAID_TEXT, EDITED_TEXT, TEXT_COMPRESSION, ADDRESS_FORMAT_ANOMALY, DATE_FORMAT_ANOMALY, FONT_ANOMALY, NAME_FORMAT_ANOMALY, PDF_ALIGNMENT, BRUSH_DETECTION, METADATA_DATES_OUTSIDE_WINDOW, METADATA_DATES_INSIDE_WINDOW, METADATA_DATES_MISSING, METADATA_DATES_MATCH, ADOBE_FONTS, ANNOTATION_DATES, ANNOTATIONS, EDITED_WHILE_SCANNED, EXIF_DATA_MODIFIED, HIGH_USER_ACCESS, MALFORMED_DATE, QPDF, TEXT_LAYER_TEXT, TOUCHUP_TEXT, FLATTENED_PDF, BLACKLISTS, COPYCAT_IMAGE, COPYCAT_TEXT, REJECTED_CUSTOMER, TEMPLATES, SOFTWARE_BLACKLISThas_fraud_risknullableboolean
Indicates whether fraud risk was detected on the field.
signal_descriptionnullablestring
A human-readable explanation providing more detail about the specific risk signal.
page_numbernullableinteger
The relevant page associated with the risk signal. If the risk signal is not associated with a specific page, the value will be 0.
itemobject
Metadata about the Item.
item_idstring
The Plaid Item ID. The
item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.institution_idnullablestring
The Plaid Institution ID associated with the Item. Field is
null for Items created via Same Day Micro-deposits.webhooknullablestring
The URL registered to receive webhooks for the Item.
errornullableobject
Errors are identified by
error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.error_typestring
A broad categorization of the error. Safe for programmatic use.
Possible values:
INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR, SANDBOX_ERROR, PARTNER_ERROR, TRANSACTIONS_ERROR, TRANSACTION_ERROR, TRANSFER_ERRORerror_codestring
The particular error code. Safe for programmatic use.
error_code_reasonnullablestring
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors;
Possible values:
null will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_messagestring
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagenullablestring
A user-friendly representation of the error code.
This may change over time and is not safe for programmatic use.
null if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_idstring
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarray
In this product, a request can pertain to more than one Item. If an error is returned for such a request,
causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.statusnullableinteger
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstring
The URL of a Plaid documentation page with more information about the error
suggested_actionnullablestring
Suggested steps for resolving the error
available_products[string]
A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with
billed_products.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankbilled_products[string]
A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with
available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankproducts[string]
A list of products added to the Item. In almost all cases, this will be the same as the
billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products.Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bankconsented_products[string]
A list of products that the user has consented to for the Item via Data Transparency Messaging. This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product.
Possible values:
assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, transactions, income, income_verification, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, cra_base_report, cra_income_insights, cra_partner_insights, cra_cashflow_insights, layerconsent_expirationnullablestring
The date and time at which the Item's access consent will expire, in ISO 8601 format
Format:
date-time update_typestring
Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
background - Item can be updated in the backgrounduser_present_required - Item requires user interaction to be updatedPossible values:
background, user_present_requiredrequest_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "accounts": [3 {4 "account_id": "ZXEbW7Rkr9iv1qj8abebU1KDMlkexgSgrLAod",5 "balances": {6 "available": null,7 "current": null,8 "iso_currency_code": "USD",9 "limit": null,10 "unofficial_currency_code": null11 },12 "documents": [13 {14 "document_id": "9f838fef-b0a5-4ef4-bf73-8e5248d43ad7",15 "metadata": {16 "document_type": "BANK_STATEMENT",17 "is_account_number_match": true,18 "last_updated": "2024-09-25T23:57:12Z",19 "page_count": 1,20 "uploaded_at": "2024-09-25T23:57:12Z"21 },22 "risk_insights": {23 "risk_signals": [24 {25 "has_fraud_risk": true,26 "page_number": 0,27 "signal_description": "Creation date and modification date do not match",28 "type": "METADATA_DATES_OUTSIDE_WINDOW"29 },30 {31 "has_fraud_risk": true,32 "page_number": 0,33 "signal_description": "Adobe Acrobat",34 "type": "SOFTWARE_BLACKLIST"35 }36 ],37 "risk_summary": {38 "risk_score": 10039 }40 }41 }42 ],43 "mask": "0000",44 "name": "Checking ...0000",45 "official_name": null,46 "owners": [47 {48 "addresses": [49 {50 "data": {51 "city": "OAKLAND",52 "country": "US",53 "postal_code": "94103",54 "region": "CA",55 "street": "1234 GRAND AVE"56 },57 "primary": true58 }59 ],60 "document_id": "9f838fef-b0a5-4ef4-bf73-8e5248d43ad7",61 "emails": [],62 "names": [63 "JANE DOE"64 ],65 "phone_numbers": []66 }67 ],68 "subtype": "checking",69 "type": "depository",70 "verification_status": "manually_verified"71 }72 ],73 "item": {74 "available_products": [],75 "billed_products": [76 "auth"77 ],78 "consent_expiration_time": null,79 "error": null,80 "item_id": "QwpzDByRv8uvdpwKEW3WU4PkGEApajtp3o4NN",81 "products": [82 "auth"83 ],84 "update_type": "background",85 "webhook": "https://www.example.com/webhook"86 },87 "request_id": "b5jvmskusjwX5Gs"88}Was this helpful?
Webhooks (beta)
This feature is in currently in beta; please reach out to your Plaid Account Manager if you would like it enabled.
DEFAULT_UPDATE
Fired when a change to identity data has been detected on an Item. Items are checked for identity updates every 30-90 days. We recommend that upon receiving this webhook you make another call to /identity/get to fetch the user's latest identity data.
webhook_typestring
IDENTITYwebhook_codestring
DEFAULT_UPDATEitem_idstring
The
item_id of the Item associated with this webhook, warning, or erroraccount_ids_withobject
An object with keys of
Example:
account_id's that are mapped to their respective identity attributes that changed.Example:
{ "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58": ["PHONES"] }errorobject
Errors are identified by
error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.error_typestring
A broad categorization of the error. Safe for programmatic use.
Possible values:
INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR, SANDBOX_ERROR, PARTNER_ERROR, TRANSACTIONS_ERROR, TRANSACTION_ERROR, TRANSFER_ERRORerror_codestring
The particular error code. Safe for programmatic use.
error_code_reasonstring
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors;
Possible values:
null will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_messagestring
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagestring
A user-friendly representation of the error code.
This may change over time and is not safe for programmatic use.
null if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_idstring
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarray
In this product, a request can pertain to more than one Item. If an error is returned for such a request,
causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.statusinteger
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstring
The URL of a Plaid documentation page with more information about the error
suggested_actionstring
Suggested steps for resolving the error
environmentstring
The Plaid environment the webhook was sent from
Possible values:
sandbox, production1{2 "webhook_type": "IDENTITY",3 "webhook_code": "DEFAULT_UPDATE",4 "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "account_ids_with_updated_identity": {6 "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp": [7 "ADDRESSES"8 ]9 },10 "error": null,11 "environment": "production"12}