User endpoints

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.

1const request = {
2  client_user_id: 'c0e2c4ee-b763-4af5-cfe9-46a46bce883d',
3  consumer_report_user_identity: {
4    first_name: "Carmen",
5    last_name: "Berzatto",
6    phone_numbers: ["+13125551212"],
7    emails: ["carmy@example.com", "bear@example.com"],
8    ssn_last_4: "1234",
9    date_of_birth: "1987-01-31",
10    primary_address: {
11      city: "Chicago",
12      region: "IL",
13      street: "3200 W Armitage Ave",
14      postal_code: "60657",
15      country: "US"      
16    }
17  }
18};
19
20try {
21  const response = await client.userCreate(request);
22} catch (error) {
23  // handle error
24}

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.

1const request = {
2  user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
3  consumer_report_user_identity: {
4    first_name: "Carmen",
5    last_name: "Berzatto",
6    phone_numbers: ["+13125551212"],
7    emails: ["carmy@example.com", "bear@example.com"],
8    ssn_last_4: "1234",
9    date_of_birth: "1987-01-31",
10    primary_address: {
11      city: "Chicago",
12      region: "IL",
13      street: "3200 W Armitage Ave",
14      postal_code: "60657",
15      country: "US"      
16    }
17  }
18};
19
20try {
21  const response = await client.userUpdate(request);
22} catch (error) {
23  // handle error
24}

/user/remove deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist. If a user is created for a given client_user_id using /user/create and that user is then deleted with /user/remove, the client_user_id cannot be reused for another /user/create request.

1const request = {
2  user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab'
3};
4
5try {
6  const response = await client.userRemove(request);
7} catch (error) {
8  // handle error
9}

Returns Items associated with a User along with their corresponding statuses.

1const request = {
2  user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab'
3};
4
5try {
6  const response = await client.userItemsGetRequest(request);
7} catch (error) {
8  // handle error
9}