plaid

Create user

This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user.

The consumer_report_user_identity object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the /user/create call, it can be added later by calling /user/update. Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be US.

If you call the endpoint multiple times with the same client_user_id, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given client_user_id.

Ensure that you store the user_token along with your user's identifier in your database, as it is not possible to retrieve a previously created user_token.

post/user/create

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.

client_user_idstring required

A unique ID representing the end user. Maximum of 128 characters. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

end_customerstring

A unique ID representing a CRA reseller's end customer. Maximum of 128 characters.

Response

OK

user_tokenstring

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

user_idstring required

The Plaid user_id of the User associated with this webhook, warning, or error.

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