Plaid logo
Docs
ALL DOCS

API

  • Overview
  • Libraries
  • API versioning
  • Postman Collection
  • Webhooks
Product API reference
  • Transactions
  • Auth
  • Balance
  • Identity
  • Assets
  • Investments
  • Liabilities
  • Payment Initiation
  • Transfer (beta)
  • Income
  • Identity Verification (early access)
  • Monitor (early access)
Other API reference
  • Item endpoints and webhooks
  • Account endpoints and schemas
  • Institution endpoints
  • Token flow and endpoints
  • Processor and partner endpoints
  • Sandbox endpoints
Plaid logo
Docs
Plaid.com
Get API keys

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/getFetch identity data

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.
This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
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.

identity/get

Request fields and example

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 Item
2const 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 error
12}
identity/get

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 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.
availablenullable number
The amount of funds available to be withdrawn from the account, as determined by the financial institution.
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
currentnullable number
The total amount of funds in or owed by the account.
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
limitnullable number
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_codenullable string
The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.
unofficial_currency_codenullable string
The unofficial currency code associated with the balance. Always null if 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_datetimenullable string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the balance for the given account has been updated
This is currently only provided when the min_last_updated_datetime is passed when calling /accounts/balance/get for ins_128026 (Capital One).


Format: date-time
masknullable string
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_namenullable string
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 card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.


Possible values: investment, credit, depository, loan, brokerage, other
subtypenullable string
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null
verification_statusstring
The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_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.


Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed
owners[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. 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 versioning
names[string]
A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support. 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 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.
datastring
The phone number.
primaryboolean
When true, identifies the phone number as the primary number on an account.
typestring
The type of phone number.

Possible values: home, work, office, mobile, mobile1, other
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.
datastring
The email address.
primaryboolean
When true, identifies the email address as the primary email on an account.
typestring
The type of email account as described by the financial institution.

Possible values: primary, secondary, other
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.
citystring
The full city name
regionnullable string
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_codenullable string
The postal code. In API versions 2018-05-22 and earlier, this field is called zip.
countrynullable string
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_idnullable string
The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.
webhooknullable string
The URL registered to receive webhooks for the Item.
errornullable object
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be null if no error has occurred.
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
error_codestring
The particular error code. Safe for programmatic use.
error_messagestring
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagenullable string
A user-friendly representation of the error code. 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 the Assets 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.
statusnullable number
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_actionnullable string
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, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
billed_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, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
products[string]
A list of authorized products for the Item.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
consented_products[string]
Beta: A list of products that have gone through consent collection for the Item. Only present for those enabled in the beta.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
consent_expiration_timenullable string
The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the ITEM_LOGIN_REQUIRED error state. To circumvent the ITEM_LOGIN_REQUIRED error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.
Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.


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 background
user_present_required - Item requires user interaction to be updated


Possible values: background, user_present_required
request_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": null
11 },
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": true
27 },
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": false
37 }
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": null
89 },
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": true
105 },
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": false
115 }
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?
Developer community
Github logo
StackOverflow logo
Twitter logo