authGet
POST {{baseUrl}}/auth/get
The /auth/get endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.
Note: This request may take some time to complete if auth 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.
Also note that /auth/get will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
Versioning note: In API version 2017-03-08, the schema of the numbers object returned by this endpoint is substantially different. For details, see Plaid API versioning.
Request Body
{"access_token"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "options"=>{"account_ids"=>["<string>", "<string>"]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
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","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","verification_status":"\u003cstring\u003e"}],"numbers":{"ach":[{"account_id":"\u003cstring\u003e","account":"\u003cstring\u003e","routing":"\u003cstring\u003e","wire_routing":"\u003cstring,null\u003e"},{"account_id":"\u003cstring\u003e","account":"\u003cstring\u003e","routing":"\u003cstring\u003e","wire_routing":"\u003cstring,null\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"}