plaid

Retrieve identity data

Changed on

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. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.

Note: In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see Plaid API versioning.

post/identity/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/identity/get
  • Auth
    • API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
    • or OAuth 2
      Client credentials
      Token URL: https://api.plaid.com/oauth2/apiv2/token scopes: identity:read

Request body

client_idstring

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.

secretstring

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.

access_tokenstring required

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

Response

OK

request_idstring required

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

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the // response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the // response property for the response status

    • info

      added the optional property /// to the response with the status

  • e07a869352e8Revision changes
    • breaking

      the response property //////// became nullable for the status

    • info

      the endpoint scheme security clientId AND secret AND plaidVersion was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      added the optional property / to the response with the status

    • info

      removed the charge card enum value from the /// response property for the response status

    • info

      removed the installment enum value from the /// response property for the response status