> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update user

> To update a specific user resource, send a PUT request to the /users/{token} endpoint.

PUT/users/\{token}

To update a specific user resource, send a `PUT` request to the `/users/{token}` endpoint. Include the user `token` path parameter to specify the user to update.

To unlink a child user account from a parent account, pass a null value to the `parent_token` field of the child user resource.

## URL path parameters

| Fields | Description |
| - | - |
| token string  Required | Unique identifier of the user resource you want to update. **Allowable Values:**  Existing user resource token |

## Request body

| Fields | Description |
| - | - |
| account\_holder\_group\_token string  Optional | Associates the specified account holder group with the cardholder. Send a `GET` request to `/accountholdergroups` to retrieve account holder group tokens. **Allowable Values:**  36 char max |
| address1 string  Optional | Cardholder address. **NOTE:** Required for KYC verification (US-based cardholders only). Cannot perform KYC if set to a PO Box. **Allowable Values:**  255 char max |
| address2 string  Optional | Additional address information for the cardholder. **NOTE:** Cannot perform KYC if set to a PO Box. **Allowable Values:**  255 char max |
| birth\_date string  Optional | Cardholder date of birth. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  Format: yyyy-MM-dd |
| birth\_place string  Optional | Country where the cardholder was born. **Allowable Values:**  255 char max  ISO 3166 two-character country codes. For example, the country code for the United States is `US`.  The ISO maintains the [full list of ISO-3166 country codes](https://www.iso.org/iso-3166-country-codes.html). |
| city string  Optional | The city that corresponds to the address. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max |
| company string  Optional | Company name. **Allowable Values:**  255 char max |
| corporate\_card\_holder boolean  Optional | Specifies if the cardholder holds a corporate card. **Allowable Values:**  `true`, `false` |
| country string  Optional | Country in which the cardholder resides. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max **NOTE:**[ISO alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) is required for KYC verification. `US`, for example. |
| email string  Optional | Valid email address for the cardholder. This value must be unique among cardholders. **Allowable Values:**  1–255 chars |
| first\_name string  Optional | Cardholder first name. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max |
| gender string  Optional | Gender of the cardholder. **Allowable Values:**  `F`, `M` |
| honorific string  Optional | Cardholder title or prefix: Ms., Mr., Miss, Mrs. **Allowable Values:**  10 char max |
| id\_card\_expiration\_date string  Optional | Expiration date of the cardholder's identification card. **Allowable Values:**  Format: yyyy-MM-dd |
| id\_card\_number string  Optional | Cardholder's identification card number. **Allowable Values:**  255 char max |
| identifications array of objects  Optional | One or more objects containing identifications associated with the cardholder. **Allowable Values:**  Valid array of one or more `identifications` objects |
| identifications\[].**expiration\_date** string  Optional | Expiration date of the identification, if applicable. **Allowable Values:**  Format: yyyy-MM-dd |
| identifications\[].**type** string  Required | Type of identification. **NOTE:** Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the `SSN` type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the `BUSINESS_TAX_ID` or `BUSINESS_NUMBER` type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. `123456789`, for example. **Allowable Values:**  `SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE` |
| identifications\[].**value** string  Optional | Number associated with the identification. **Allowable Values:**  255 char max **NOTE:** Digits only, do not use separators. For example: 123456789 |
| ip\_address string  Optional | Cardholder IP address. **Allowable Values:**  39 char max |
| last\_name string  Optional | Cardholder last name. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max |
| metadata object  Optional | Associates any additional metadata you provide with the cardholder. **Allowable Values:**  You can define the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`. |
| middle\_name string  Optional | Cardholder middle name. **Allowable Values:**  40 char max |
| nationality string  Optional | Cardholder nationality. **Allowable Values:**  255 char max |
| notes string  Optional | Any additional information pertaining to the cardholder. **Allowable Values:**  255 char max |
| parent\_token string  Optional | Unique identifier of an existing user or business resource. Required if `uses_parent_account = true`. This account holder is configured as the parent of the current cardholder. To unlink a child account from a parent account, update this field to a null value. **Allowable Values:**  1–36 chars |
| passport\_expiration\_date string  Optional | Expiration date of the cardholder's passport. **Allowable Values:**  Format: yyyy-MM-dd |
| passport\_number string  Optional | Cardholder passport number. **Allowable Values:**  40 char max |
| password string  Optional | Cardholder's user account password on the Marqeta platform. **Allowable Values:**  255 char max |
| phone string  Optional | Cardholder telephone number (including area code), prepended by the `+` symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. **Allowable Values:**  255 char max  Format: +15105551212 or +35552260859 |
| postal\_code string  Optional | Postal code of the cardholder's address. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  10 char max |
| ssn string  Optional | Cardholder's Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). **Allowable Values:**  Nine digits only, no delimiters. `123456789`, for example. **NOTE:** Required for KYC verification (US-based cardholders only). |
| state string  Optional | State where the cardholder resides (`CA` for California, for example). **NOTE:**[Two-character abbreviation](https://www.marqeta.com/docs/core-api/kyc-verification/perform.md#_valid_state_provincial_territorial_and_federal_abbreviations) required for KYC verification (US-based cardholders only). **Allowable Values:**  32 char max |
| title string  Optional | Professional title of the cardholder, such as Chief Comptroller. **Allowable Values:**  255 char max |
| token string  Optional | Unique identifier of the cardholder. **Allowable Values:**  1–36 chars |
| uses\_parent\_account boolean  Optional | Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). If set to `true`, you must also include a `parent_token` in the request. This value cannot be updated. **Allowable Values:**  `true`, `false` **Default value:** `false` |

## Sample request body

```json JSON lines wrap theme={null}
{
  "address1": "4321 Grove Street"
}
```

## Response body

| Fields | Description |
| - | - |
| account\_holder\_group\_token string  Conditionally returned | Associates the specified account holder group with the cardholder. Send a `GET` request to `/accountholdergroups` to retrieve account holder group tokens. **Allowable Values:**  36 char max |
| active boolean  Conditionally returned | Specifies if the cardholder is in the `ACTIVE` state on the Marqeta platform. **NOTE:** Do not set the value of the `user.active` field directly. Instead, use the `/usertransitions` endpoints to transition user resources between statuses. For more information on status changes, see [Create User Transition](https://www.marqeta.com/docs/core-api/user-transitions/create-user-transition.md). **Allowable Values:**  `true`, `false` |
| address1 string  Conditionally returned | Cardholder's address. **NOTE:** Required for KYC verification (US-based cardholders only). Cannot perform KYC if set to a PO Box. **Allowable Values:**  255 char max |
| address2 string  Conditionally returned | Additional address information for the cardholder. **NOTE:** Cannot perform KYC if set to a PO Box. **Allowable Values:**  255 char max |
| birth\_date string  Conditionally returned | Cardholder's date of birth. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  Format: yyyy-MM-dd |
| birth\_place string  Conditionally returned | Country where the cardholder was born. **Allowable Values:**  255 char max  ISO 3166 two-character country codes. For example, the country code for the United States is `US`.  The ISO maintains the [full list of ISO-3166 country codes](https://www.iso.org/iso-3166-country-codes.html). |
| city string  Conditionally returned | City where the cardholder resides. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max |
| company string  Conditionally returned | Company name. **Allowable Values:**  255 char max |
| corporate\_card\_holder boolean  Conditionally returned | Specifies if the cardholder holds a corporate card. **Allowable Values:**  `true`, `false` **Default value:** `false` |
| country string  Conditionally returned | Country where the cardholder resides. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max **NOTE:**[ISO alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) required for KYC verification. `US`, for example. |
| email string  Conditionally returned | Valid email address of the cardholder. This value must be unique among users. **NOTE:** Required for KYC verification by certain banks (US-based cardholders only). To determine if you must provide an email address, contact your Marqeta representative. **Allowable Values:**  1–255 chars |
| first\_name string  Conditionally returned | Cardholder's first name. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max |
| gender string  Conditionally returned | Gender of the cardholder. **Allowable Values:**  `F`, `M` |
| honorific string  Conditionally returned | Cardholder's title or prefix: Dr., Miss, Mr., Ms., and so on. **Allowable Values:**  10 char max |
| id\_card\_expiration\_date string  Conditionally returned | Expiration date of the cardholder's identification card. **Allowable Values:**  Format: yyyy-MM-dd |
| id\_card\_number string  Conditionally returned | Cardholder's identification card number. **Allowable Values:**  255 char max |
| identifications array of objects  Conditionally returned | One or more objects containing identifications associated with the cardholder. **Allowable Values:**  Valid array of one or more `identifications` objects |
| identifications\[].**expiration\_date** string  Conditionally returned | Expiration date of the identification, if applicable. **Allowable Values:**  Format: yyyy-MM-dd |
| identifications\[].**type** string  Returned | Type of identification. **NOTE:** Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the `SSN` type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the `BUSINESS_TAX_ID` or `BUSINESS_NUMBER` type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. `123456789`, for example. **Allowable Values:**  `SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE` |
| identifications\[].**value** string  Conditionally returned | Number associated with the identification. **Allowable Values:**  255 char max **NOTE:** Digits only, do not use separators. For example: 123456789 |
| ip\_address string  Conditionally returned | Cardholder's IP address. **Allowable Values:**  39 char max |
| last\_name string  Conditionally returned | Cardholder's last name. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  40 char max |
| metadata object  Conditionally returned | Associates any additional metadata you provide with the cardholder. **Allowable Values:**  You can define the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`. |
| middle\_name string  Conditionally returned | Cardholder's middle name. **Allowable Values:**  40 char max |
| nationality string  Conditionally returned | Cardholder's nationality. **Allowable Values:**  255 char max |
| notes string  Conditionally returned | Any additional information pertaining to the cardholder. **Allowable Values:**  255 char max |
| parent\_token string  Conditionally returned | Unique identifier of the parent user or business resource. Send a `GET` request to `/users` to retrieve user resource tokens or to `/businesses` to retrieve business resource tokens. Required if `uses_parent_account = true`. This user or business is configured as the parent of the current user. **Allowable Values:**  1–36 chars |
| passport\_expiration\_date string  Conditionally returned | Expiration date of the cardholder's passport. **Allowable Values:**  Format: yyyy-MM-dd |
| passport\_number string  Conditionally returned | Cardholder's passport number. **Allowable Values:**  40 char max |
| password string  Conditionally returned | Password to the cardholder's user account on the Marqeta platform. - Must contain at least one numeral - Must contain at least one lowercase letter - Must contain at least one uppercase letter - Must contain at least one of these symbols: `@``#``$``%``!``^``&``*``(``)` `\\``_``+``~``-``=``[``]``\{``}` `,``;``:``'``"``.``/``<``>``?``` ` `` **Allowable Values:**  255 char max |
| phone string  Conditionally returned | Telephone number of the cardholder (including area code), prepended by the `+` symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. **NOTE:** Required for KYC verification by certain banks (US-based cardholders only). To determine if you must provide a phone number, contact your Marqeta representative. **Allowable Values:**  255 char max  Format: +15105551212 or +35552260859 |
| postal\_code string  Conditionally returned | Postal code of the cardholder's address. **NOTE:** Required for KYC verification (US-based cardholders only). **Allowable Values:**  10 char max |
| ssn string  Conditionally returned | Cardholder's Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). **Allowable Values:**  Nine digits only, no delimiters. `123456789`, for example. |
| state string  Conditionally returned | State or province where the cardholder resides. **NOTE:**[Valid two-character abbreviation](https://www.marqeta.com/docs/core-api/kyc-verification/perform.md#_valid_state_provincial_territorial_and_federal_abbreviations) required for KYC verification (US-based cardholders only). **Allowable Values:**  32 char max |
| title string  Conditionally returned | Professional title of the cardholder, such as Chief Comptroller. **NOTE:** Do not use this field for honorific titles such as Mr., Mrs., Miss, Ms., Mx., Sir, or Dame. Instead, add these to the `honorific` field. **Allowable Values:**  255 char max |
| token string  Conditionally returned | Unique identifier of the cardholder. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. **Allowable Values:**  1–36 chars |
| uses\_parent\_account boolean  Conditionally returned | Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). If set to `true`, you must also include a `parent_token` in the request. This value cannot be updated. **Allowable Values:**  `true`, `false` **Default value:** `false` |

## Sample response body

```json JSON lines wrap theme={null}
{
  "token": "my_user_01",
  "active": true,
  "address1": "4321 Grove Street",
  "uses_parent_account": false,
  "corporate_card_holder": false,
  "created_time": "2023-01-29T00:12:20Z",
  "last_modified_time": "2023-09-23T21:41:24Z",
  "metadata": {},
  "account_holder_group_token": "DEFAULT_AHG",
  "status": "ACTIVE"
}
```


## Related topics

- [Update user password](https://www.marqeta.com/docs/core-api/users/user-authentication/update-password.md)
- [Users Overview](https://www.marqeta.com/docs/core-api/users.md)
- [Updating Multi-Factor Authentication in the Marqeta Dashboard](https://www.marqeta.com/docs/developer-guides/mq-eu-mfa-in-mqd.md)
- [User Authentication Overview](https://www.marqeta.com/docs/core-api/users/user-authentication.md)
- [Managing Physical Cards](https://www.marqeta.com/docs/developer-guides/managing-physical-cards.md)