Skip to main content
POST
/
auth
/
get
/auth/get
curl --request POST \
  --url http://localhost:8080/plaid-compatible/auth/get \
  --header 'Content-Type: application/json' \
  --header 'PLAID-CLIENT-ID: <api-key>' \
  --data '{
  "client_id": "<string>",
  "secret": "<string>",
  "access_token": "<string>",
  "options": {
    "account_ids": [
      "<string>"
    ]
  }
}'
{
  "accounts": [
    {
      "account_id": "<string>",
      "balances": {
        "available": 123,
        "current": 123,
        "limit": 123,
        "iso_currency_code": "<string>"
      },
      "mask": "<string>",
      "name": "<string>",
      "type": "investment",
      "subtype": {}
    }
  ],
  "numbers": {
    "ach": [
      {
        "account_id": "<string>",
        "account": "<string>",
        "routing": "<string>",
        "wire_routing": "<string>"
      }
    ],
    "eft": [
      {
        "account_id": "<string>",
        "account": "<string>",
        "institution": "<string>",
        "branch": "<string>"
      }
    ],
    "international": [
      {
        "account_id": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      }
    ],
    "bacs": [
      {
        "account_id": "<string>",
        "account": "<string>",
        "sort_code": "<string>"
      }
    ]
  },
  "item": {
    "item_id": "<string>",
    "institution_id": "<string>",
    "webhook": "<string>",
    "error": {
      "error_type": "INVALID_REQUEST",
      "error_code": "<string>",
      "error_message": "<string>",
      "display_message": "<string>",
      "request_id": "<string>",
      "causes": [
        {}
      ],
      "status": 123,
      "documentation_url": "<string>",
      "suggested_action": "<string>"
    },
    "available_products": [
      "transactions"
    ],
    "billed_products": [
      "transactions"
    ],
    "products": [
      "transactions"
    ],
    "consented_products": [
      "transactions"
    ]
  },
  "request_id": "<string>"
}

Authorizations

​
PLAID-CLIENT-ID
string
header
required

Headers

​
Plaid-Version
string | null

Body

application/json

AuthGetRequest defines the request schema for /auth/get

​
access_token
string
required

The access token associated with the Item data is being requested for.

​
client_id
string | null

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.

​
secret
string | null

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.

​
options
object | null

An optional object to filter /auth/get results.

Response

OK

AuthGetResponse defines the response schema for /auth/get

​
accounts
AccountBase · object[]
required

The accounts for which numbers are being retrieved.

​
numbers
object
required

An object containing identifying numbers used for making electronic transfers to and from the accounts. The identifying number type (ACH, EFT, IBAN, or BACS) used will depend on the country of the account. An account may have more than one number type. If a particular identifying number type is not used by any accounts for which data has been requested, the array for that type will be empty.

​
item
object
required

Metadata about the Item.

​
request_id
string
required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.