Skip to main content
POST
/
identity
/
get
/identity/get
curl --request POST \
  --url http://localhost:8080/plaid-compatible/identity/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": {},
      "owners": [
        {
          "names": [
            "<string>"
          ],
          "phone_numbers": [
            {
              "data": "<string>",
              "primary": true,
              "type": "<string>"
            }
          ],
          "emails": [
            {
              "data": "<string>",
              "primary": true
            }
          ],
          "addresses": [
            {
              "data": {
                "city": "<string>",
                "region": "<string>",
                "street": "<string>",
                "postal_code": "<string>",
                "country": "<string>"
              },
              "primary": true
            }
          ]
        }
      ]
    }
  ],
  "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

IdentityGetRequest defines the request schema for /identity/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 /identity/get results.

Response

OK

IdentityGetResponse defines the response schema for /identity/get

​
accounts
AccountIdentity · object[]
required

The accounts for which Identity data has been requested

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