POST /accountHolders

Creates an account holder linked to a legal entity.

Servers

https://balanceplatform-api-test.adyen.com/bcl/v2

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`description`	String	No	Your description for the account holder.
`balancePlatform`	String	No	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.
`contactDetails`	Object	No	Contact details of the account holder.
`contactDetails.email`	String	Yes	The email address of the account holder.
`contactDetails.webAddress`	String	No	The URL of the account holder's website.
`contactDetails.phone`	Object	Yes	The phone number of the account holder.
`contactDetails.phone.number`	String	Yes	The full phone number provided as a single string. For example, "0031 6 11 22 33 44", "+316/1122-3344", or "(0031) 611223344".
`contactDetails.phone.type`	String	Yes	Type of phone number. Possible values: Landline, Mobile. Possible values: `"mobile"` `"landline"`
`contactDetails.address`	Object	Yes	The address of the account holder.
`contactDetails.address.postalCode`	String	Yes	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`contactDetails.address.stateOrProvince`	String	No	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.
`contactDetails.address.country`	String	Yes	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`.
`contactDetails.address.houseNumberOrName`	String	Yes	The number or name of the house. Maximum length: 3000 characters.
`contactDetails.address.street`	String	Yes	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`.
`contactDetails.address.city`	String	Yes	The name of the city. Maximum length: 3000 characters.
`metadata`	Object	No	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.
`reference`	String	No	Your reference for the account holder.
`migratedAccountHolderCode`	String	No	The unique identifier of the migrated account holder in the classic integration.
`capabilities`	Object	No	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.
`legalEntityId`	String	Yes	The unique identifier of the legal entity associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
`timeZone`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.