identityGet

POST {{baseUrl}}/identity/get

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: 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.

Request Body

{"access_token"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "options"=>{"account_ids"=>["<string>", "<string>"]}}

HEADERS

RESPONSES

status: OK

{"accounts":[{"account_id":"\u003cstring\u003e","balances":{"available":"\u003cnumber,null\u003e","current":"\u003cnumber,null\u003e","limit":"\u003cnumber,null\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","last_updated_datetime":"\u003cstring,null\u003e"},"mask":"\u003cstring,null\u003e","name":"\u003cstring\u003e","official_name":"\u003cstring,null\u003e","type":"\u003cstring\u003e","subtype":"\u003cstring,number\u003e","owners":[{"names":["\u003cstring\u003e","\u003cstring\u003e"],"phone_numbers":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"emails":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"addresses":[{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"},{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"}]},{"names":["\u003cstring\u003e","\u003cstring\u003e"],"phone_numbers":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"emails":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"addresses":[{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"},{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"}]}],"verification_status":"\u003cstring\u003e"},{"account_id":"\u003cstring\u003e","balances":{"available":"\u003cnumber,null\u003e","current":"\u003cnumber,null\u003e","limit":"\u003cnumber,null\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","last_updated_datetime":"\u003cstring,null\u003e"},"mask":"\u003cstring,null\u003e","name":"\u003cstring\u003e","official_name":"\u003cstring,null\u003e","type":"\u003cstring\u003e","subtype":"\u003cstring,number\u003e","owners":[{"names":["\u003cstring\u003e","\u003cstring\u003e"],"phone_numbers":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"emails":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"addresses":[{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"},{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"}]},{"names":["\u003cstring\u003e","\u003cstring\u003e"],"phone_numbers":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"emails":[{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"data":"\u003cstring\u003e","primary":"\u003cboolean\u003e","type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"addresses":[{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"},{"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primary":"\u003cboolean\u003e"}]}],"verification_status":"\u003cstring\u003e"}],"item":{"item_id":"\u003cstring\u003e","webhook":"\u003cstring,null\u003e","error":{"error_type":"\u003cstring\u003e","error_code":"\u003cstring\u003e","error_message":"\u003cstring\u003e","display_message":"\u003cstring,null\u003e","request_id":"\u003cstring\u003e","causes":["\u003cobject\u003e","\u003cobject\u003e"],"status":"\u003cnumber,null\u003e","documentation_url":"\u003cstring\u003e","suggested_action":"\u003cstring\u003e"},"available_products":["\u003cstring\u003e","\u003cstring\u003e"],"billed_products":["\u003cstring\u003e","\u003cstring\u003e"],"consent_expiration_time":"\u003cstring,null\u003e","update_type":"\u003cstring\u003e","institution_id":"\u003cstring,null\u003e","products":["\u003cstring\u003e","\u003cstring\u003e"]},"request_id":"\u003cstring\u003e"}