Sign in
plaid

Update user information

This endpoint is used to update user information associated with an existing user_token. It can also be used to enable an existing user_token for use with Consumer Reports by Plaid Check, by adding a consumer_report_user_identity object to the user. Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be US.

post/user/update

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_tokenstring

The user token associated with the User data is being requested for.

user_idstring

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

Example request

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

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