Sign in
plaid

Retrieve user identity and information.

Retrieve user identity and information using a Plaid generated user ID. This endpoint returns user details including the most recent Identity object that was added to the given User.

post/user/get

Headers

Plaid-New-User-API-Enabledboolean

The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.

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.

user_idstring required

A unique user_id generated by Plaid for the client-provided client_user_id. This field is currently in beta.

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.

user_idstring required

A unique user_id generated by Plaid for the client-provided client_user_id. This field is currently in beta.

client_user_idstring nullable required

Client provided user ID.

created_atstring date-time required

Timestamp of user creation.

updated_atstring date-time

Timestamp of last user update.

Example response

{
  "identity": {
    "id_numbers": [
      {
        "value": "123456789",
        "type": "us_ssn"
      }
    ]
  }
}

Changes