Retrieve Identity

POST https://{{env_url}}/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.

Request Body

{"client_id"=>"{{client_id}}", "secret"=>"{{secret_key}}", "access_token"=>"{{access_token}}"}

HEADERS

RESPONSES

status: OK

{"accounts":[{"account_id":"wp5rJy31NMfyEJNDvoqXhbwLlRaEGyCrwWWdy","balances":{"available":100,"current":110,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"mask":"0000","name":"Plaid Checking","official_name":"Plaid Gold Standard 0% Interest Checking","subtype":"checking","type":"depository"},{"account_id":"l418dp7olxiDAaok8E1pi5Q7n9NGkzfZQbbAp","balances":{"available":200,"current":210,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"mask":"1111","name":"Plaid Saving","official_name":"Plaid Silver Standard 0.1% Interest Saving","subtype":"savings","type":"depository"},{"account_id":"5NVq637arPcAbDxWd7GZUd3g5pjXPWFZlNNLz","balances":{"available":null,"current":1000,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"mask":"2222","name":"Plaid CD","official_name":"Plaid Bronze Standard 0.2% Interest CD","subtype":"cd","type":"depository"},{"account_id":"kamgkLwoG3iMQPzlvEaZSGnMVR36rLiWnZZRW","balances":{"available":null,"current":410,"iso_currency_code":"USD","limit":2000,"unofficial_currency_code":null},"mask":"3333","name":"Plaid Credit Card","official_name":"Plaid Diamond 12.5% APR Interest Credit Card","subtype":"credit card","type":"credit"},{"account_id":"Jzbo9AkW8vcleKXgyPJ4cjva1KQw7qid3RRNb","balances":{"available":43200,"current":43200,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"mask":"4444","name":"Plaid Money Market","official_name":"Plaid Platinum Standard 1.85% Interest Money Market","subtype":"money market","type":"depository"}],"identity":{"addresses":[{"accounts":["Plaid Checking 0000","Plaid Saving 1111","Plaid CD 2222"],"data":{"city":"Malakoff","state":"NY","street":"2992 Cameron Road","zip":"14236"},"primary":true},{"accounts":["Plaid Credit Card 3333"],"data":{"city":"San Matias","state":"CA","street":"2493 Leisure Lane","zip":"93405-2255"},"primary":false}],"emails":[{"data":"accountholder0@example.com","primary":true,"type":"primary"},{"data":"accountholder1@example.com","primary":false,"type":"secondary"},{"data":"extraordinarily.long.email.username.123456@reallylonghostname.com","primary":false,"type":"other"}],"names":["Alberta Bobbeth Charleson"],"phone_numbers":[{"data":"1112223333","primary":false,"type":"home"},{"data":"1112224444","primary":false,"type":"work"},{"data":"1112225555","primary":false,"type":"mobile1"}]},"item":{"available_products":["assets","balance","credit_details"],"billed_products":["auth","identity","income","transactions"],"error":null,"institution_id":"ins_3","item_id":"QNWnmvzAKwcx9RwPXqVMSoRBjkroVnhpge7bq","webhook":"https://www.genericwebhookurl.com/webhook"},"request_id":"yt4tV"}