Retrieve Identity data

POST /processor/identity/get

The /processor/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

Required

ProcessorIdentityGetRequest defines the request schema for /processor/identity/get

Parameters

client_id
string
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
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.
processor_token
required, string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

Response

ProcessorIdentityGetResponse defines the response schema for /processor/identity/get

Response Properties

account
required, object
Identity information about an account
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.