PATCH /accountHolders/{id}

The unique identifier of the account holder.

Default value: "application/json"

The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.

Your description for the account holder.

The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.

List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.

The unique identifiers of the bank account(s) that the deadline applies to

The date that verification is due by before capabilities are disallowed.

The names of the capabilities to be disallowed.

Contact details of the account holder.

The email address of the account holder.

The URL of the account holder's website.

The phone number of the account holder.

The full phone number provided as a single string. For example, "0031 6 11 22 33 44", "+316/1122-3344",

or "(0031) 611223344".

Type of phone number. Possible values: Landline, Mobile.

Possible values:

• "mobile"
• "landline"

The address of the account holder.

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The number or name of the house. Maximum length: 3000 characters.

The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

The name of the city. Maximum length: 3000 characters.

A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired.

Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.

The status of the account holder.

Possible values:

• active: The account holder is active. This is the default status when creating an account holder.

• suspended: The account holder is permanently deactivated by Adyen. This action cannot be undone.

• closed: The account holder is permanently deactivated by you. This action cannot be undone.

Possible values:

• "active"
• "suspended"
• "closed"

Your reference for the account holder.

The unique identifier of the migrated account holder in the classic integration.

Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing. The value is an object containing the settings for the capability.

The time zone of the account holder. For example, Europe/Amsterdam. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the list of time zone codes.