User endpoints  =============== #### API reference for user management endpoints  This page covers API endpoints related to user ids and user tokens, which are used by [Plaid Check](https://plaid.com/docs/check/index.html.md) , Plaid Protect, and [Income](https://plaid.com/docs/income/index.html.md) , as well as by the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/index.html.md) . | Guides | | | --- | --- | | [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) | Overview of changes introduced in the new User APIs | | [Migrate to new User APIs](https://plaid.com/docs/api/users/migrate-to-new-user-apis/index.html.md) | Migration guide for existing Consumer Report integrations on legacy User APIs | | Endpoints | | | --- | --- | | [/user/create](https://plaid.com/docs/api/users/index.html.md#usercreate) | Create a user ID | | [/user/get](https://plaid.com/docs/api/users/index.html.md#userget) | Get user details | | [/user/update](https://plaid.com/docs/api/users/index.html.md#userupdate) | Update user data or enable an existing user for Plaid Check | | [/user/remove](https://plaid.com/docs/api/users/index.html.md#userremove) | Remove the user and their associated Items | | [/user/items/get](https://plaid.com/docs/api/users/index.html.md#useritemsget) | Return Items associated with a user | | [/user/items/remove](https://plaid.com/docs/api/users/index.html.md#useritemsremove) | Remove Items associated with a User | | [/user/products/terminate](https://plaid.com/docs/api/users/index.html.md#userproductsterminate) | Terminate user-based products | | See also | | | --- | --- | | [/sandbox/user/reset\_login](https://plaid.com/docs/api/sandbox/index.html.md#sandboxuserreset_login) | Force user into an error state for testing | Plaid has switched from using the `user_token` to the `user_id` as of December 10, 2025. If you have an existing integration that uses the `user_token`, you should continue to use the `user_token`. New customers must use the `user_id`. To accommodate both flows, many Plaid API endpoints use either a `user_id` or a `user_token`. In these API requests, you should provide a `user_token` only if you have one; otherwise, provide a `user_id`. You do not need to provide both fields. For more details on this change, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . #### User identifiers  There are three identifiers Plaid uses when working with users: `client_user_id`: The unique identifier you provide to Plaid for each end user in your application. This is determined by you and will typically correspond to your application's primary key for a user record. It must not contain PII, such as a phone number, Social Security number, or email address. `user_id`: Plaid-generated identifier, prefixed by `usr_` and returned in responses from the User APIs and [/link/token/create](https://plaid.com/docs/api/link/index.html.md#linktokencreate) . Each `user_id` corresponds to a single `client_user_id`; calling [/user/create](https://plaid.com/docs/api/users/index.html.md#usercreate) repeatedly with the same `client_user_id` returns the same `user_id`. The `user_id` is used by customers who integrated on December 10, 2025 or later. `user_token` — A Plaid-generated token for accessing the user. Only applicable for customers who integrated with [/user/create](https://plaid.com/docs/api/users/index.html.md#usercreate) prior to December 10, 2025. Note that `user_tokens` can also have corresponding `user_id`s; these are not equivalent to the new `usr_` `user_id`s mentioned above. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . \=\*=\*=\*= #### /user/create  #### Create user  For Plaid products and flows that use the user object, [/user/create](https://plaid.com/docs/api/users/index.html.md#usercreate) provides you a single token to access all data associated with the user. You must call this endpoint before calling [/link/token/create](https://plaid.com/docs/api/link/index.html.md#linktokencreate) if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect (Identity). If you are using Plaid Protect Link session scoring, you do not need to call [/user/create](https://plaid.com/docs/api/users/index.html.md#usercreate) first; Plaid will resolve or create the user when `user.client_user_id` is provided in [/link/token/create](https://plaid.com/docs/api/link/index.html.md#linktokencreate) . For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a `client_user_id` and an `identity` object and will return a `user_id`. For customers who began using it before that date, the endpoint takes a `client_user_id` and a `consumer_report_user_identity` object and will return a `user_token` and `user_id`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . In order to create a Plaid Check Consumer Report for a user, the `identity` (new) or `consumer_report_user_identity` (legacy) object must be present. If it is not provided during the [/user/create](https://plaid.com/docs/api/users/index.html.md#usercreate) call, it can be added later by calling [/user/update](https://plaid.com/docs/api/users/index.html.md#userupdate) . In order to generate a Plaid Check Consumer Report, the following `identity` fields, at minimum, are required and must be non-empty: `name`, `date_of_birth`, `emails`, `phone_numbers`, and `addresses`, (with at least one email, phone number, and address designated as `primary`). Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If creating a report for sharing with a GSE such as Fannie or Freddie, the user's full SSN must be provided via the `id_numbers` field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an `identity` object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products. #### Request fields  string 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. string 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. required, string 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`. Max length: `128` Min length: `1` object The identity fields associated with a user. For a user to be eligible for a Plaid Check Consumer Report, all fields are required except `id_number`. Providing a partial SSN is strongly recommended, and improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. If creating a report that will be shared with GSEs such as Fannie or Freddie, a full Social Security Number must be provided via the `id_number` field. object User name information. required, string User's given name. required, string User's family name. string The user's date of birth, to be provided in the format "yyyy-mm-dd". Format: `date` \[object\] The user's emails. required, string User's email. required, boolean Indicates whether this is the primary email for the User. \[object\] The user's phone numbers, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment. required, string User's phone number. required, boolean Indicates whether this is the primary phone number for the User. \[object\] The user's addresses. string First line of street address. string Second line of street address. string City name. string State, province or region. required, string Country code. string Postal or ZIP code. required, boolean Indicates whether this is the primary address for the User. \[object\] The user's ID numbers. required, string Value of the identity document typed in by the user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see [Input Validation Rules](https://plaid.com/docs/identity-verification/hybrid-input-validation/index.html.md#id-numbers) . required, string A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see [Input Validation Rules](https://plaid.com/docs/identity-verification/hybrid-input-validation/index.html.md#id-numbers) . Possible values: `ar_dni`, `au_drivers_license`, `au_passport`, `br_cpf`, `ca_sin`, `cl_run`, `cn_resident_card`, `co_nit`, `dk_cpr`, `eg_national_id`, `es_dni`, `es_nie`, `hk_hkid`, `in_pan`, `it_cf`, `jo_civil_id`, `jp_my_number`, `ke_huduma_namba`, `kw_civil_id`, `mx_curp`, `mx_rfc`, `my_nric`, `ng_nin`, `nz_drivers_license`, `om_civil_id`, `ph_psn`, `pl_pesel`, `ro_cnp`, `sa_national_id`, `se_pin`, `sg_nric`, `tr_tc_kimlik`, `us_ssn`, `us_ssn_last_4`, `za_smart_id` object This field is only used by integrations created before December 10, 2025. All other integrations must use the `identity` object instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . To create a Plaid Check Consumer Report for a user when using a `user_token`, this field must be present. If this field is not provided during user token creation, you can add it to the user later by calling `/user/update`. Once the field has been added to the user, you will be able to call `/link/token/create` with a non-empty `consumer_report_permissible_purpose` (which will automatically create a Plaid Check Consumer Report), or call `/cra/check_report/create` for that user. required, string The user's first name required, string The user's last name required, \[string\] The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment. required, \[string\] The user's emails string The user's full social security number. This field should only be provided by lenders intending to share the resulting consumer report with a Government-Sponsored Enterprise (GSE), such as Fannie Mae or Freddie Mac. Format: "ddd-dd-dddd" string The last 4 digits of the user's social security number. Max length: `4` Min length: `4` required, string To be provided in the format "yyyy-mm-dd". This field is required for all Plaid Check customers. Format: `date` required, object Data about the components comprising an address. required, string The full city name required, string The region or state. In API versions 2018-05-22 and earlier, this field is called `state`. Example: `"NC"` required, string The full street address Example: `"564 Main Street, APT 15"` required, string The postal code. In API versions 2018-05-22 and earlier, this field is called `zip`. required, string The ISO 3166-1 alpha-2 country code boolean If your integration with the User API predates December 10, 2025, set this field to `true` to opt into the [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . When enabled, you can use the `identity` field instead of `consumer_report_user_identity`. ```bash curl -X POST https://sandbox.plaid.com/user/create \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "client_user_id": "c0e2c4ee-b763-4af5-cfe9-46a46bce883d", "identity": { "name": { "given_name": "Carmen", "family_name": "Berzatto" }, "date_of_birth": "1987-01-31", "emails": [ { "data": "carmen@example.com", "primary": true } ], "phone_numbers": [ { "data": "+13125551212", "primary": true }, { "data": "+12125551212", "primary": false } ], "addresses": [ { "street_1": "3200 W Armitage Ave", "street_2": null, "city": "Chicago", "region": "IL", "country": "US", "postal_code": "60657", "primary": true } ], "id_numbers": [ { "value": "1234", "type": "us_ssn_last_4" } ] } }' ``` ```node const request = { client_user_id: "c0e2c4ee-b763-4af5-cfe9-46a46bce883d", identity: { name: { given_name: "Carmen", family_name: "Berzatto" }, date_of_birth: "1987-01-31", emails: [ { data: "carmy@example.com", primary: true }, { data: "bear@example.com", primary: false } ], phone_numbers: [ { data: "+13125551212", primary: true } ], addresses: [ { street_1: "3200 W Armitage Ave", street_2: null, city: "Chicago", region: "IL", country: "US", postal_code: "60657", primary: true } ], id_numbers: [ { value: "1234", type: "us_ssn_last_4" } ] } }; try { const response = await client.userCreate(request); } catch (error) { } ``` ```python request = UserCreateRequest( client_user_id="c0e2c4ee-b763-4af5-cfe9-46a46bce883d", identity=ClientUserIdentity( name=ClientUserIdentityName( given_name="Carmen", family_name="Berzatto" ), date_of_birth=date(1987, 1, 31), emails=[ ClientUserIdentityEmail(data="carmy@example.com", primary=True), ClientUserIdentityEmail(data="bear@example.com", primary=False) ], phone_numbers=[ ClientUserIdentityPhoneNumber(data="+13125551212", primary=True) ], addresses=[ ClientUserIdentityAddress( street_1="3200 W Armitage Ave", street_2=None, city="Chicago", region="IL", country="US", postal_code="60657", primary=True ) ], id_numbers=[ UserIDNumber( value="1234", type="us_ssn_last_4" ) ] ) ) response = client.user_create(request) ``` ```ruby request = Plaid::UserCreateRequest.new( client_user_id: "c0e2c4ee-b763-4af5-cfe9-46a46bce883d", identity: { name: { given_name: "Carmen", family_name: "Berzatto" }, date_of_birth: "1987-01-31", emails: [ { data: "carmy@example.com", primary: true }, { data: "bear@example.com", primary: false } ], phone_numbers: [ { data: "+13125551212", primary: true } ], addresses: [ { street_1: "3200 W Armitage Ave", street_2: nil, city: "Chicago", region: "IL", country: "US", postal_code: "60657", primary: true } ], id_numbers: [ { value: "1234", type: "us_ssn_last_4" } ] } ) response = client.user_create(request) ``` ```java ClientUserIdentityAddress addressData = new ClientUserIdentityAddress() .street1("3200 W Armitage Ave") .street2(null) .city("Chicago") .region("IL") .country("US") .postalCode("60657") .primary(true); ClientUserIdentityName name = new ClientUserIdentityName() .givenName("Carmen") .familyName("Berzatto"); ClientUserIdentityEmail email1 = new ClientUserIdentityEmail() .data("carmy@example.com") .primary(true); ClientUserIdentityEmail email2 = new ClientUserIdentityEmail() .data("bear@example.com") .primary(false); ClientUserIdentityPhoneNumber phone1 = new ClientUserIdentityPhoneNumber() .data("+13125551212") .primary(true); UserIDNumber idNumber = new UserIDNumber() .value("1234") .type(IDNumberType.US_SSN_LAST_4); ClientUserIdentity clientUserIdentity = new ClientUserIdentity() .name(name) .dateOfBirth(LocalDate.parse("1987-01-31")) .emails(Arrays.asList(email1, email2)) .phoneNumbers(Arrays.asList(phone1)) .addresses(Arrays.asList(addressData)) .idNumbers(Arrays.asList(idNumber)); UserCreateRequest request = new UserCreateRequest() .clientUserId("c0e2c4ee-b763-4af5-cfe9-46a46bce883d") .identity(clientUserIdentity); Response response = client .userCreate(request) .execute(); ``` ```go city := "Chicago" region := "IL" street := "3200 W Armitage Ave" postalCode := "60657" country := "US" DateOfBirth := "1987-01-31" emails := []string{"carmy@example.com", "bear@example.com"} phoneNumbers := []string{"+13125551212"} firstName := "Carmen" lastName := "Berzatto" ssnLast4 := "1234" addressData := plaid.NewClientUserIdentityAddress(country, true) addressData.SetStreet1(street) addressData.SetCity(city) addressData.SetRegion(region) addressData.SetPostalCode(postalCode) name := plaid.ClientUserIdentityName{ GivenName: firstName, FamilyName: lastName, } clientUserEmails := []plaid.ClientUserIdentityEmail{} for i, e := range emails { clientUserEmails = append(clientUserEmails, plaid.ClientUserIdentityEmail{ Data: e, Primary: i == 0, }) } clientUserPhones := []plaid.ClientUserIdentityPhoneNumber{} for i, p := range phoneNumbers { clientUserPhones = append(clientUserPhones, plaid.ClientUserIdentityPhoneNumber{ Data: p, Primary: i == 0, }) } idNumber := plaid.UserIDNumber{ Value: ssnLast4, Type: "us_ssn_last_4", } clientUserIdentity := plaid.ClientUserIdentity{ Name: &name, DateOfBirth: plaid.NewNullableString(&DateOfBirth), Emails: clientUserEmails, PhoneNumbers: clientUserPhones, Addresses: []plaid.ClientUserIdentityAddress{*addressData}, IdNumbers: []plaid.UserIDNumber{idNumber}, } request := plaid.NewUserCreateRequest( "c0e2c4ee-b763-4af5-cfe9-46a46bce883d", ) request.SetIdentity(clientUserIdentity) response, _, err := client.PlaidApi.UserCreate(ctx).UserCreateRequest(*request).Execute() ``` #### Response fields  string The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. Response Object ```json { "user_id": "usr_9nSp2KuZ2x4JDw", "request_id": "Aim3b" } ``` \=\*=\*=\*= #### /user/get  #### Retrieve user identity and information  Get user details using a `user_id`. This endpoint only supports users that were created on the new user API flow, without a `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . #### Request fields  string 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. string 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. required, string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . ```bash curl -X POST https://sandbox.plaid.com/user/get \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "user_id": "usr_9nSp2KuZ2x4JDw" }' ``` ```node const request = { user_id: "usr_9nSp2KuZ2x4JDw" }; try { const response = await client.userGet(request); } catch (error) { } ``` ```python request = UserGetRequest( user_id="usr_9nSp2KuZ2x4JDw", ) response = client.user_get(request) ``` ```ruby request = Plaid::UserGetRequest.new( { user_id: "usr_9nSp2KuZ2x4JDw", } ) response = client.user_get(request) ``` ```java UserGetRequest request = new UserGetRequest() .userId("usr_9nSp2KuZ2x4JDw"); Response response = client .userGet(request) .execute(); ``` ```go request := plaid.UserGetRequest{ UserId: plaid.PtrString("usr_9nSp2KuZ2x4JDw"), } response, _, err := client.PlaidApi.UserGet(ctx).UserGetRequest(request).Execute() ``` #### Response fields  string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . nullable, string Client provided user ID. string Timestamp of user creation. Format: `date-time` string Timestamp of last user update. Format: `date-time` nullable, object The identity fields associated with a user. For a user to be eligible for a Plaid Check Consumer Report, all fields are required except `id_number`. Providing a partial SSN is strongly recommended, and improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. If creating a report that will be shared with GSEs such as Fannie or Freddie, a full Social Security Number must be provided via the `id_number` field. nullable, object User name information. string User's given name. string User's family name. nullable, string The user's date of birth, to be provided in the format "yyyy-mm-dd". Format: `date` \[object\] The user's emails. string User's email. boolean Indicates whether this is the primary email for the User. \[object\] The user's phone numbers, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment. string User's phone number. boolean Indicates whether this is the primary phone number for the User. \[object\] The user's addresses. nullable, string First line of street address. nullable, string Second line of street address. nullable, string City name. nullable, string State, province or region. string Country code. nullable, string Postal or ZIP code. boolean Indicates whether this is the primary address for the User. \[object\] The user's ID numbers. string Value of the identity document typed in by the user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see [Input Validation Rules](https://plaid.com/docs/identity-verification/hybrid-input-validation/index.html.md#id-numbers) . string A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see [Input Validation Rules](https://plaid.com/docs/identity-verification/hybrid-input-validation/index.html.md#id-numbers) . Possible values: `ar_dni`, `au_drivers_license`, `au_passport`, `br_cpf`, `ca_sin`, `cl_run`, `cn_resident_card`, `co_nit`, `dk_cpr`, `eg_national_id`, `es_dni`, `es_nie`, `hk_hkid`, `in_pan`, `it_cf`, `jo_civil_id`, `jp_my_number`, `ke_huduma_namba`, `kw_civil_id`, `mx_curp`, `mx_rfc`, `my_nric`, `ng_nin`, `nz_drivers_license`, `om_civil_id`, `ph_psn`, `pl_pesel`, `ro_cnp`, `sa_national_id`, `se_pin`, `sg_nric`, `tr_tc_kimlik`, `us_ssn`, `us_ssn_last_4`, `za_smart_id` Response Object ```json { "user_id": "usr_8c6ZbDAYjacUXF", "client_user_id": "uid_12345", "created_at": "2019-02-15T15:51:39Z", "updated_at": "2019-02-15T15:52:39Z", "request_id": "m8MDnv9okwxFNBV", "identity": { "name": { "given_name": "Alice", "family_name": "Johnson" }, "date_of_birth": "1988-07-22", "emails": [ { "data": "alice.johnson@example.com", "primary": true }, { "data": "alice.j@workmail.com", "primary": false } ], "phone_numbers": [ { "data": "+15551234567", "primary": true }, { "data": "+15559876543", "primary": false } ], "addresses": [ { "street_1": "123 Main St", "street_2": "Apt 4B", "city": "Anytown", "region": "CA", "country": "US", "postal_code": "90210", "primary": true } ], "id_numbers": [ { "value": "1234", "type": "us_ssn_last_4" } ] } } ``` \=\*=\*=\*= #### /user/update  #### Update user information  This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. creating a Consumer Report) use [/user/update](https://plaid.com/docs/api/users/index.html.md#userupdate) to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged. #### Request fields  string 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. string 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. string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . object The identity fields associated with a user. For a user to be eligible for a Plaid Check Consumer Report, all fields are required except `id_number`. Providing a partial SSN is strongly recommended, and improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. If creating a report that will be shared with GSEs such as Fannie or Freddie, a full Social Security Number must be provided via the `id_number` field. object User name information. required, string User's given name. required, string User's family name. string The user's date of birth, to be provided in the format "yyyy-mm-dd". Format: `date` \[object\] The user's emails. required, string User's email. required, boolean Indicates whether this is the primary email for the User. \[object\] The user's phone numbers, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment. required, string User's phone number. required, boolean Indicates whether this is the primary phone number for the User. \[object\] The user's addresses. string First line of street address. string Second line of street address. string City name. string State, province or region. required, string Country code. string Postal or ZIP code. required, boolean Indicates whether this is the primary address for the User. \[object\] The user's ID numbers. required, string Value of the identity document typed in by the user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see [Input Validation Rules](https://plaid.com/docs/identity-verification/hybrid-input-validation/index.html.md#id-numbers) . required, string A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see [Input Validation Rules](https://plaid.com/docs/identity-verification/hybrid-input-validation/index.html.md#id-numbers) . Possible values: `ar_dni`, `au_drivers_license`, `au_passport`, `br_cpf`, `ca_sin`, `cl_run`, `cn_resident_card`, `co_nit`, `dk_cpr`, `eg_national_id`, `es_dni`, `es_nie`, `hk_hkid`, `in_pan`, `it_cf`, `jo_civil_id`, `jp_my_number`, `ke_huduma_namba`, `kw_civil_id`, `mx_curp`, `mx_rfc`, `my_nric`, `ng_nin`, `nz_drivers_license`, `om_civil_id`, `ph_psn`, `pl_pesel`, `ro_cnp`, `sa_national_id`, `se_pin`, `sg_nric`, `tr_tc_kimlik`, `us_ssn`, `us_ssn_last_4`, `za_smart_id` string The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . object This field is only used by integrations created before December 10, 2025. All other integrations must use the `identity` object instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . To create a Plaid Check Consumer Report for a user when using a `user_token`, this field must be present. If this field is not provided during user token creation, you can add it to the user later by calling `/user/update`. Once the field has been added to the user, you will be able to call `/link/token/create` with a non-empty `consumer_report_permissible_purpose` (which will automatically create a Plaid Check Consumer Report), or call `/cra/check_report/create` for that user. required, string The user's first name required, string The user's last name required, \[string\] The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment. required, \[string\] The user's emails string The user's full social security number. This field should only be provided by lenders intending to share the resulting consumer report with a Government-Sponsored Enterprise (GSE), such as Fannie Mae or Freddie Mac. Format: "ddd-dd-dddd" string The last 4 digits of the user's social security number. Max length: `4` Min length: `4` required, string To be provided in the format "yyyy-mm-dd". This field is required for all Plaid Check customers. Format: `date` required, object Data about the components comprising an address. required, string The full city name required, string The region or state. In API versions 2018-05-22 and earlier, this field is called `state`. Example: `"NC"` required, string The full street address Example: `"564 Main Street, APT 15"` required, string The postal code. In API versions 2018-05-22 and earlier, this field is called `zip`. required, string The ISO 3166-1 alpha-2 country code ```bash curl -X POST https://sandbox.plaid.com/user/update \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "user_id": "usr_9nSp2KuZ2x4JDw", "identity": { "name": { "given_name": "Carmen", "family_name": "Berzatto" }, "date_of_birth": "1987-01-31", "emails": [ { "data": "carmen@example.com", "primary": true } ], "phone_numbers": [ { "data": "+13125551212", "primary": true }, { "data": "+12125551212", "primary": false } ], "addresses": [ { "street_1": "3200 W Armitage Ave", "street_2": null, "city": "Chicago", "region": "IL", "country": "US", "postal_code": "60657", "primary": true } ], "id_numbers": [ { "value": "1234", "type": "us_ssn_last_4" } ] } }' ``` ```node const request = { user_id: 'usr_9nSp2KuZ2x4JDw', identity: { name: { given_name: "Carmen", family_name: "Berzatto" }, date_of_birth: "1987-01-31", emails: [ { data: "carmy@example.com", primary: true }, { data: "bear@example.com", primary: false } ], phone_numbers: [ { data: "+13125551212", primary: true } ], addresses: [ { street_1: "3200 W Armitage Ave", street_2: null, city: "Chicago", region: "IL", country: "US", postal_code: "60657", primary: true } ], id_numbers: [ { value: "1234", type: "us_ssn_last_4" } ] } }; try { const response = await client.userUpdate(request); } catch (error) { // handle error } ``` ```python request = UserUpdateRequest( user_id='usr_9nSp2KuZ2x4JDw', identity=ClientUserIdentity( name=ClientUserIdentityName( given_name='Carmen', family_name='Berzatto' ), date_of_birth='1987-01-31', emails=[ ClientUserIdentityEmail(data='carmy@example.com', primary=True), ClientUserIdentityEmail(data='bear@example.com', primary=False), ], phone_numbers=[ ClientUserIdentityPhoneNumber(data='+13125551212', primary=True), ], addresses=[ ClientUserIdentityAddress( street_1='3200 W Armitage Ave', street_2=None, city='Chicago', region='IL', country='US', postal_code='60657', primary=True, ) ], id_numbers=[ UserIDNumber( value='1234', type='us_ssn_last_4', ) ] ) ) response = client.user_update(request) ``` ```ruby request = Plaid::UserUpdateRequest.new( { user_id: 'usr_9nSp2KuZ2x4JDw', identity: { name: { given_name: "Carmen", family_name: "Berzatto" }, date_of_birth: "1987-01-31", emails: [ { data: "carmy@example.com", primary: true }, { data: "bear@example.com", primary: false } ], phone_numbers: [ { data: "+13125551212", primary: true } ], addresses: [ { street_1: "3200 W Armitage Ave", street_2: nil, city: "Chicago", region: "IL", country: "US", postal_code: "60657", primary: true } ], id_numbers: [ { value: "1234", type: "us_ssn_last_4" } ] } } ) response = client.user_update(request) ``` ```java ClientUserIdentityAddress addressData = new ClientUserIdentityAddress(). street1("3200 W Armitage Ave"). street2(null). city("Chicago"). region("IL"). country("US"). postalCode("60657"). primary(true); ClientUserIdentityName name = new ClientUserIdentityName(). givenName("Carmen"). familyName("Berzatto"); ClientUserIdentityEmail email1 = new ClientUserIdentityEmail(). data("carmy@example.com"). primary(true); ClientUserIdentityEmail email2 = new ClientUserIdentityEmail(). data("bear@example.com"). primary(false); ClientUserIdentityPhoneNumber phone1 = new ClientUserIdentityPhoneNumber(). data("+13125551212"). primary(true); UserIDNumber idNumber = new UserIDNumber(). value("1234"). type(IDNumberType.US_SSN_LAST_4); ClientUserIdentity clientUserIdentity = new ClientUserIdentity(). name(name). dateOfBirth("1987-01-31"). emails(Arrays.asList(email1, email2)). phoneNumbers(Arrays.asList(phone1)). addresses(Arrays.asList(addressData)). idNumbers(Arrays.asList(idNumber)); UserUpdateRequest request = new UserUpdateRequest() .userId("usr_9nSp2KuZ2x4JDw") .identity(clientUserIdentity); Response response = client .userUpdate(request) .execute(); ``` ```go city := "Chicago" region := "IL" street := "3200 W Armitage Ave" postalCode := "60657" country := "US" emails := []string{"carmy@example.com", "bear@example.com"} phoneNumbers := []string{"+13125551212"} addressData := plaid.ClientUserIdentityAddress{ Street1: &street, Street2: nil, City: &city, Region: ®ion, Country: country, PostalCode: &postalCode, Primary: true, } name := plaid.ClientUserIdentityName{ GivenName: "Carmen", FamilyName: "Berzatto", } clientUserEmails := []plaid.ClientUserIdentityEmail{} for i, e := range emails { clientUserEmails = append(clientUserEmails, plaid.ClientUserIdentityEmail{ Data: e, Primary: i == 0, }) } clientUserPhones := []plaid.ClientUserIdentityPhoneNumber{} for i, p := range phoneNumbers { clientUserPhones = append(clientUserPhones, plaid.ClientUserIdentityPhoneNumber{ Data: p, Primary: i == 0, }) } idNumber := plaid.UserIDNumber{ Value: "1234", Type: "us_ssn_last_4", } clientUserIdentity := plaid.ClientUserIdentity{ Name: &name, DateOfBirth: plaid.NewNullableString(plaid.PtrString("1987-01-31")), Emails: clientUserEmails, PhoneNumbers: clientUserPhones, Addresses: []plaid.ClientUserIdentityAddress{addressData}, IdNumbers: []plaid.UserIDNumber{idNumber}, } request := plaid.NewUserUpdateRequest() request.SetUserId("usr_9nSp2KuZ2x4JDw") request.SetIdentity(clientUserIdentity) response, _, err := client.PlaidApi.UserUpdate(ctx).UserUpdateRequest(*request).Execute() ``` #### Response fields  string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. Response Object ```json { "request_id": "Aim3b" } ``` \=\*=\*=\*= #### /user/remove  #### Remove user  [/user/remove](https://plaid.com/docs/api/users/index.html.md#userremove) deletes a `user_id` or `user_token` and associated information, including any Items associated with the user. #### Request fields  string 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. string 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. string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . string The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . ```bash curl -X POST https://sandbox.plaid.com/user/remove \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "user_id": "usr_9nSp2KuZ2x4JDw" }' ``` ```node const request = { user_id: 'usr_9nSp2KuZ2x4JDw' }; try { const response = await client.userRemove(request); } catch (error) { // handle error } ``` ```python request = UserRemoveRequest( user_id='usr_9nSp2KuZ2x4JDw', ) response = client.user_remove(request) ``` ```ruby request = Plaid::UserRemoveRequest.new( { user_id: 'usr_9nSp2KuZ2x4JDw', } ) response = client.user_remove(request) ``` ```java UserRemoveRequest request = new UserRemoveRequest() .userId("usr_9nSp2KuZ2x4JDw"); Response response = client .userRemove(request) .execute(); ``` ```go request := plaid.UserRemoveRequest{ UserId: plaid.PtrString("usr_9nSp2KuZ2x4JDw"), } response, _, err := client.PlaidApi.UserRemove(ctx).UserRemoveRequest(request).Execute() ``` #### Response fields  string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. Response Object ```json { "request_id": "Aim3b" } ``` \=\*=\*=\*= #### /user/items/get  #### Get Items associated with a User  Returns Items associated with a `user_id`, along with their corresponding statuses. Plaid associates an Item with a User when it has been successfully connected within a Link session initialized with that `user_id`. #### Request fields  string 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. string 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. string The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . ```bash curl -X POST https://sandbox.plaid.com/user/items/get \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "user_id": "usr_9nSp2KuZ2x4JDw" }' ``` ```node const request = { user_id: 'usr_9nSp2KuZ2x4JDw' }; try { const response = await client.userItemsGet(request); } catch (error) { // handle error } ``` ```python request = UserItemsGetRequest( user_id='usr_9nSp2KuZ2x4JDw', ) response = client.user_items_get(request) ``` ```ruby request = Plaid::UserItemsGetRequest.new( { user_id: 'usr_9nSp2KuZ2x4JDw', } ) response = client.user_items_get(request) ``` ```java UserItemsGetRequest request = new UserItemsGetRequest() .userId("usr_9nSp2KuZ2x4JDw"); Response response = client .userItemsGet(request) .execute(); ``` ```go request := plaid.NewUserItemsGetRequest() request.SetUserId("usr_9nSp2KuZ2x4JDw") response, _, err := client.PlaidApi.UserItemsGet(ctx).UserItemsGetRequest(*request).Execute() ``` #### Response fields  \[object\] string The Plaid Item ID. The `item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. Like all Plaid identifiers, the `item_id` is case-sensitive. nullable, string The Plaid Institution ID associated with the Item. Field is `null` for Items created without an institution connection, such as Items created via Same-Day Micro-deposits. nullable, string The name of the institution associated with the Item. Field is `null` for Items created without an institution connection, such as Items created via Same-Day Micro-deposits. nullable, string The URL registered to receive webhooks for the Item. nullable, string The method used to populate Auth data for the Item. This field is only populated for Items that have had Auth numbers data set on at least one of its accounts, and will be `null` otherwise. For info about the various flows, see our [Auth coverage documentation](https://plaid.com/docs/auth/coverage/index.html.md) . `INSTANT_AUTH`: The Item's Auth data was provided directly by the user's institution connection. `INSTANT_MATCH`: The Item's Auth data was provided via the Instant Match fallback flow. `AUTOMATED_MICRODEPOSITS`: The Item's Auth data was provided via the Automated Micro-deposits flow. `SAME_DAY_MICRODEPOSITS`: The Item's Auth data was provided via the Same-Day Micro-deposits flow. `INSTANT_MICRODEPOSITS`: The Item's Auth data was provided via the Instant Micro-deposits flow. `DATABASE_MATCH`: The Item's Auth data was provided via the Database Match flow. `DATABASE_INSIGHTS`: The Item's Auth data was provided via the Database Insights flow. `TRANSFER_MIGRATED`: The Item's Auth data was provided via [/transfer/migrate\_account](https://plaid.com/docs/api/products/transfer/account-linking/index.html.md#migrate-account-into-transfers) . `INVESTMENTS_FALLBACK`: The Item's Auth data for Investments Move was provided via a [fallback flow](https://plaid.com/docs/investments-move/index.html.md#fallback-flows) . Possible values: `INSTANT_AUTH`, `INSTANT_MATCH`, `AUTOMATED_MICRODEPOSITS`, `SAME_DAY_MICRODEPOSITS`, `INSTANT_MICRODEPOSITS`, `DATABASE_MATCH`, `DATABASE_INSIGHTS`, `TRANSFER_MIGRATED`, `INVESTMENTS_FALLBACK`, `null` nullable, object Errors are identified by `error_code` and categorized by `error_type`. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-`null` error object will only be part of an API response when calling `/item/get` to view Item status. Otherwise, error fields will be `null` if no error has occurred; if an error has occurred, an error code will be returned instead. string A broad categorization of the error. Safe for programmatic use. Possible values: `INVALID_REQUEST`, `INVALID_RESULT`, `INVALID_INPUT`, `INSTITUTION_ERROR`, `RATE_LIMIT_EXCEEDED`, `API_ERROR`, `ITEM_ERROR`, `ASSET_REPORT_ERROR`, `RECAPTCHA_ERROR`, `OAUTH_ERROR`, `PAYMENT_ERROR`, `BANK_TRANSFER_ERROR`, `INCOME_VERIFICATION_ERROR`, `MICRODEPOSITS_ERROR`, `SANDBOX_ERROR`, `PARTNER_ERROR`, `SIGNAL_ERROR`, `TRANSACTIONS_ERROR`, `TRANSACTION_ERROR`, `TRANSFER_ERROR`, `CHECK_REPORT_ERROR`, `CONSUMER_REPORT_ERROR`, `USER_ERROR` string The particular error code. Safe for programmatic use. nullable, string The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection. string A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use. nullable, string A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use. string A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks. array In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object. nullable, integer The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook. string The URL of a Plaid documentation page with more information about the error nullable, string Suggested steps for resolving the error \[string\] A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product. \[string\] A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product. \[string\] A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with `billed_products`. Possible values: `assets`, `auth`, `balance`, `balance_plus`, `beacon`, `identity`, `identity_match`, `investments`, `investments_auth`, `liabilities`, `payment_initiation`, `identity_verification`, `transactions`, `credit_details`, `income`, `income_verification`, `standing_orders`, `transfer`, `employment`, `recurring_transactions`, `transactions_refresh`, `signal`, `statements`, `processor_payments`, `processor_identity`, `profile`, `cra_base_report`, `cra_income_insights`, `cra_partner_insights`, `cra_network_insights`, `cra_cashflow_insights`, `cra_monitoring`, `cra_lend_score`, `cra_plaid_credit_score`, `layer`, `pay_by_bank`, `protect_linked_bank`, `protect_transactions` \[string\] A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with `available_products`. Note - `billed_products` is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as `balance`, will not appear here. Possible values: `assets`, `auth`, `balance`, `balance_plus`, `beacon`, `identity`, `identity_match`, `investments`, `investments_auth`, `liabilities`, `payment_initiation`, `identity_verification`, `transactions`, `credit_details`, `income`, `income_verification`, `standing_orders`, `transfer`, `employment`, `recurring_transactions`, `transactions_refresh`, `signal`, `statements`, `processor_payments`, `processor_identity`, `profile`, `cra_base_report`, `cra_income_insights`, `cra_partner_insights`, `cra_network_insights`, `cra_cashflow_insights`, `cra_monitoring`, `cra_lend_score`, `cra_plaid_credit_score`, `layer`, `pay_by_bank`, `protect_linked_bank`, `protect_transactions` \[string\] A list of products added to the Item. In almost all cases, this will be the same as the `billed_products` field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before `/asset_report/create` has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in `products` but not in `billed_products`. Possible values: `assets`, `auth`, `balance`, `balance_plus`, `beacon`, `identity`, `identity_match`, `investments`, `investments_auth`, `liabilities`, `payment_initiation`, `identity_verification`, `transactions`, `credit_details`, `income`, `income_verification`, `standing_orders`, `transfer`, `employment`, `recurring_transactions`, `transactions_refresh`, `signal`, `statements`, `processor_payments`, `processor_identity`, `profile`, `cra_base_report`, `cra_income_insights`, `cra_partner_insights`, `cra_network_insights`, `cra_cashflow_insights`, `cra_monitoring`, `cra_lend_score`, `cra_plaid_credit_score`, `layer`, `pay_by_bank`, `protect_linked_bank`, `protect_transactions` \[string\] A list of products that the user has consented to for the Item via [Data Transparency Messaging](https://plaid.com/docs/link/data-transparency-messaging-migration-guide/index.html.md) . This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product. Possible values: `assets`, `auth`, `balance`, `balance_plus`, `beacon`, `identity`, `identity_match`, `investments`, `investments_auth`, `liabilities`, `transactions`, `income`, `income_verification`, `transfer`, `employment`, `recurring_transactions`, `signal`, `statements`, `processor_payments`, `processor_identity`, `cra_base_report`, `cra_income_insights`, `cra_lend_score`, `cra_partner_insights`, `cra_cashflow_insights`, `cra_monitoring`, `layer` nullable, string The date and time at which the Item's access consent will expire, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. If the Item does not have consent expiration scheduled, this field will be `null`. Currently, only institutions in Europe and a small number of institutions in the US have expiring consent. For a list of US institutions that currently expire consent, see the [OAuth Guide](https://plaid.com/docs/link/oauth/index.html.md#refreshing-item-consent) . Format: `date-time` string Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication. `background` - Item can be updated in the background `user_present_required` - Item requires user interaction to be updated Possible values: `background`, `user_present_required` string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. Response Object ```json { "items": [ { "available_products": [ "balance", "auth" ], "billed_products": [ "identity", "transactions" ], "error": null, "institution_id": "ins_109508", "institution_name": "First Platypus Bank", "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr", "update_type": "background", "webhook": "https://plaid.com/example/hook", "consent_expiration_time": null }, { "available_products": [ "balance", "identity", "payment_initiation", "transactions" ], "billed_products": [ "assets", "auth" ], "error": null, "institution_id": "ins_109508", "institution_name": "First Platypus Bank", "item_id": "DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6", "update_type": "background", "webhook": "https://plaid.com/example/hook", "consent_expiration_time": null } ], "request_id": "m8MDnv9okwxFNBV" } ``` \=\*=\*=\*= #### /user/items/remove  This endpoint is currently in early availability. To request access, contact your account manager or [submit a product access support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) . #### Remove Items from a User  Removes specific Items associated with a user. It is equivalent to calling [/item/remove](https://plaid.com/docs/api/items/index.html.md#itemremove) on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to [/item/remove](https://plaid.com/docs/api/items/index.html.md#itemremove) , this deletes Item product data and terminates billing on the Item's products. Once removed, Items cannot be reconnected without going through Link again. This endpoint is not intended to remove all data for a user, as it will only remove Items and no other data for the user. If the user has any user-based recurring subscription products (Financial Management, Plaid Protect, or CRA Cash Flow Updates) and is deleting their account with your product, also call [/user/products/terminate](https://plaid.com/docs/api/users/index.html.md#userproductsterminate) to end those subscriptions; per-Item billing is already terminated by this endpoint. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data. #### Request fields  string 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. string 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. string The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . required, \[string\] An array of `item_id`s to be deleted. All Items for removal must be currently associated with the provided `user_id` or `user_token`. Otherwise, the entire operation will error and no Items will be deleted. ```bash curl -X POST https://sandbox.plaid.com/user/items/remove \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "user_id": "usr_9nSp2KuZ2x4JDw", "item_ids": ["eVBnVMp7zdTJLkRNr33Rs6zr27KeyPMNPqfX1"] }' ``` ```node const request = { user_id: 'usr_9nSp2KuZ2x4JDw', item_ids: ['eVBnVMp7zdTJLkRNr33Rs6zr27KeyPMNPqfX1'], }; try { const response = await client.userItemsRemove(request); } catch (error) { } ``` ```python request = UserItemsRemoveRequest( user_id='usr_9nSp2KuZ2x4JDw', item_ids=['eVBnVMp7zdTJLkRNr33Rs6zr27KeyPMNPqfX1'], ) response = client.user_items_remove(request) ``` ```ruby request = Plaid::UserItemsRemoveRequest.new( { user_id: 'usr_9nSp2KuZ2x4JDw', item_ids: ['eVBnVMp7zdTJLkRNr33Rs6zr27KeyPMNPqfX1'], } ) response = client.user_items_remove(request) ``` ```java UserItemsRemoveRequest request = new UserItemsRemoveRequest() .userId("usr_9nSp2KuZ2x4JDw") .itemIds(Arrays.asList("eVBnVMp7zdTJLkRNr33Rs6zr27KeyPMNPqfX1")); Response response = client .userItemsRemove(request) .execute(); ``` ```go request := plaid.NewUserItemsRemoveRequest( []string{"eVBnVMp7zdTJLkRNr33Rs6zr27KeyPMNPqfX1"}, ) request.SetUserId("usr_9nSp2KuZ2x4JDw") response, _, err := client.PlaidApi.UserItemsRemove(ctx).UserItemsRemoveRequest(*request).Execute() ``` #### Response fields  string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. Response Object ```json { "request_id": "m8MDnv9okwxFNBV" } ``` \=\*=\*=\*= #### /user/products/terminate  #### Terminate user-based products  Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Cash Flow Updates) associated with a `user_id`. After you call this endpoint, the user will no longer be billed for these products. For CRA Monitoring, the subscription is canceled but historical data remains available for future report requests. #### Request fields  string 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. string 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. required, string A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis/index.html.md) . required, string The reason for terminating user-based products. Possible values: `FRAUD_FIRST_PARTY`, `FRAUD_FALSE_IDENTITY`, `FRAUD_ABUSE`, `FRAUD_OTHER`, `CONSUMER_LOAN_PAID_OFF`, `CONSUMER_ACCOUNT_CLOSED`, `CONSUMER_CHARGE_OFF`, `CONSUMER_PAYMENT_METHOD_SWITCHED`, `USER_OFFBOARDING`, `DUPLICATE_ITEM`, `BILLING_TERMINATION`, `OTHER` string Additional context or details about the reason for terminating user-based products. Personally identifiable information, such as an email address or phone number, should not be included in the `reason_note`. Max length: `512` ```bash curl -X POST https://sandbox.plaid.com/user/products/terminate \ -H 'Content-Type: application/json' \ -d '{ "client_id": "${PLAID_CLIENT_ID}", "secret": "${PLAID_SECRET}", "user_id": "usr_9nSp2KuZ2x4JDw", "reason_code": "CONSUMER_ACCOUNT_CLOSED", "reason_note": "User closed account with client." }' ``` ```node const request = { user_id: 'usr_9nSp2KuZ2x4JDw', reason_code: 'CONSUMER_ACCOUNT_CLOSED', reason_note: 'User closed account with client.', }; try { const response = await client.userProductsTerminate(request); } catch (error) { } ``` ```python request = UserProductsTerminateRequest( user_id='usr_9nSp2KuZ2x4JDw', reason_code='CONSUMER_ACCOUNT_CLOSED', reason_note='User closed account with client.', ) response = client.user_products_terminate(request) ``` ```ruby request = Plaid::UserProductsTerminateRequest.new( { user_id: 'usr_9nSp2KuZ2x4JDw', reason_code: 'CONSUMER_ACCOUNT_CLOSED', reason_note: 'User closed account with client.', } ) response = client.user_products_terminate(request) ``` ```java UserProductsTerminateRequest request = new UserProductsTerminateRequest() .userId("usr_9nSp2KuZ2x4JDw") .reasonCode(ProductsTerminateReasonCode.CONSUMER_ACCOUNT_CLOSED) .reasonNote("User closed account with client."); Response response = client .userProductsTerminate(request) .execute(); ``` ```go request := plaid.NewUserProductsTerminateRequest( plaid.PRODUCTSTERMINATEREASONCODE_CONSUMER_ACCOUNT_CLOSED, ) request.SetUserId("usr_9nSp2KuZ2x4JDw") request.SetReasonNote("User closed account with client.") response, _, err := client.PlaidApi.UserProductsTerminate(ctx).UserProductsTerminateRequest(*request).Execute() ``` #### Response fields  string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. Response Object ```json { "request_id": "TxlxEcCmP9HTTT" } ```