POST /createAccountHolder

Default value: "application/json"

The details of the prospective account holder.

The opaque reference value returned by the Adyen API during bank account login.

Array of bank accounts associated with the account holder. For details about the required bankAccountDetail fields, see Required information.

The street name of the residence of the bank account owner.

Refer to Required information for details on field requirements.

The postal code of the residence of the bank account owner.

Refer to Required information for details on field requirements.

The international bank account number.

The IBAN standard is defined in ISO-13616.

Refer to Required information for details on field requirements.

The tax ID number.

Refer to Required information for details on field requirements.

The bank identifier code.

Refer to Required information for details on field requirements.

The country code of the country of residence of the bank account owner.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

Refer to Required information for details on field requirements.

The city in which the bank branch is located.

Refer to Required information for details on field requirements.

The bank code of the banking institution with which the bank account is registered.

Refer to Required information for details on field requirements.

The name of the bank account owner.

Refer to Required information for details on field requirements.

Merchant reference to the bank account.

The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: checking, savings.

Refer to Required information for details on field requirements.

The house name or number of the residence of the bank account owner.

Refer to Required information for details on field requirements.

The state of residence of the bank account owner.

Refer to Required information for details on field requirements.

The unique identifier (UUID) of the Bank Account.

If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.

If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.

If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.

If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.

The URL to be used for bank account verification. This may be generated on bank account creation.

Refer to Required information for details on field requirements.

If set to true, the bank account is a primary account.

The name of the bank account.

The two-letter country code in which the bank account is registered.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

Refer to Required information for details on field requirements.

The date of birth of the bank account owner. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).

The check code of the bank account.

Refer to Required information for details on field requirements.

The currency in which the bank account deals.

The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').

The bank account number (without separators).

Refer to Required information for details on field requirements.

The name of the banking institution with which the bank account is held.

Refer to Required information for details on field requirements.

The city of residence of the bank account owner.

Refer to Required information for details on field requirements.

The country code of the country of nationality of the bank account owner.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

Refer to Required information for details on field requirements.

The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:

• United States - Routing number
• United Kingdom - Sort code
• Germany - Bankleitzahl

Refer to Required information for details on field requirements.

The phone number of the account holder.

Required if a fullPhoneNumber is not provided.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

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

The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary. 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 Merchant Category Code of the account holder.

If not specified in the request, this will be derived from the platform account (which is configured by Adyen).

The phone number of the account holder provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to Pay out to cards.

The shopperReference you sent in the /payments request when you saved the account holder's card details.

Adyen-generated unique alphanumeric identifier (UUID) for the payout method, returned in the response when you create a payout method. Required when updating an existing payout method in an /updateAccountHolder request.

The recurringDetailReference returned in the /payments response when you saved the account holder's card details.

The merchantAccount you used in the /payments request when you saved the account holder's card details.

Your reference for the payout method.

The email address of the account holder.

Details about the individual account holder. Required when creating an account holder with legalEntity Individual.

Personal information of the individual.

Array that contains information about the person's identification document. You can submit only one entry per document type.

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The state where the document was issued (if applicable).

The number in the document.

The type of the document. Possible values: ID, DRIVINGLICENSE, PASSPORT, SOCIALSECURITY, VISA.

To delete an existing entry for a document type, send only the type field in your request.

Possible values:

• "DRIVINGLICENSE"
• "ID"
• "SOCIALSECURITY"
• "PASSPORT"
• "VISA"

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The name of the individual.

Make sure your account holder registers using the name shown on their Photo ID. Maximum length: 80 characters Cannot contain numbers. /n Cannot be empty.

The gender.

The following values are permitted: MALE, FEMALE, UNKNOWN.

Possible values:

• "FEMALE"
• "MALE"
• "UNKNOWN"

The last name.

The first name.

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.

The URL of the website of the account holder.

An array containing information about the account holder's legal arrangements.

Your reference for the legal arrangement. Must be between 3 to 128 characters.

The form of legal arrangement. Required if type is Trust or Partnership.

The possible values depend on the type.

• For type Trust: CashManagementTrust, CorporateUnitTrust, DeceasedEstate, DiscretionaryInvestmentTrust, DiscretionaryServicesManagementTrust, DiscretionaryTradingTrust, FirstHomeSaverAccountsTrust, FixedTrust, FixedUnitTrust, HybridTrust, ListedPublicUnitTrust, OtherTrust, PooledSuperannuationTrust, PublicTradingTrust, or UnlistedPublicUnitTrust.

• For type Partnership: LimitedPartnership, FamilyPartnership, or OtherPartnership

Possible values:

• "DeceasedEstate"
• "HybridTrust"
• "LimitedPartnership"
• "FamilyPartnership"
• "DiscretionaryInvestmentTrust"
• "OtherTrust"
• "ListedPublicUnitTrust"
• "OtherPartnership"
• "CorporateUnitTrust"
• "FirstHomeSaverAccountsTrust"
• "FixedTrust"
• "UnlistedPublicUnitTrust"
• "DiscretionaryTradingTrust"
• "PublicTradingTrust"
• "FixedUnitTrust"
• "PooledSuperannuationTrust"
• "CashManagementTrust"
• "DiscretionaryServicesManagementTrust"

The legal name of the legal arrangement. Minimum length: 3 characters.

The registration number of the legal arrangement.

The tax identification number of the legal arrangement.

The type of legal arrangement.

Possible values:

• Association

• Partnership

• SoleProprietorship

• Trust

Possible values:

• "SoleProprietorship"
• "Trust"
• "Association"
• "Partnership"

Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement. Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.

The address of the legal arrangement.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

An array containing information about other entities that are part of the legal arrangement.

The e-mail address of the entity.

Required when creating an entity with legalEntityType Individual.

Personal information of the individual.

Array that contains information about the person's identification document. You can submit only one entry per document type.

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The state where the document was issued (if applicable).

The number in the document.

The type of the document. Possible values: ID, DRIVINGLICENSE, PASSPORT, SOCIALSECURITY, VISA.

To delete an existing entry for a document type, send only the type field in your request.

Possible values:

• "DRIVINGLICENSE"
• "ID"
• "SOCIALSECURITY"
• "PASSPORT"
• "VISA"

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The name of the individual.

Make sure your account holder registers using the name shown on their Photo ID. Maximum length: 80 characters Cannot contain numbers. /n Cannot be empty.

The gender.

The following values are permitted: MALE, FEMALE, UNKNOWN.

Possible values:

• "FEMALE"
• "MALE"
• "UNKNOWN"

The last name.

The first name.

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.

The URL of the website of the contact.

Your reference for the legal arrangement entity.

The phone number of the entity.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.

The legal entity type.

Possible values: Business, Individual, NonProfit, PublicCompany, or Partnership.

Possible values:

• "PublicCompany"
• "Business"
• "NonProfit"
• "Partnership"
• "Individual"

The phone number of the contact provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

An array containing the roles of the entity in the legal arrangement.

The possible values depend on the legal arrangement type.

• For type Association: ControllingPerson and Shareholder.

• For type Partnership: Partner and Shareholder.

• For type Trust: Trustee, Settlor, Protector, Beneficiary, and Shareholder.

The address of the entity.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

Required when creating an entity with legalEntityType Business, NonProfit, PublicCompany, or Partnership.

Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to our verification guide.

Contains information about the person.

Array that contains information about the person's identification document. You can submit only one entry per document type.

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The state where the document was issued (if applicable).

The number in the document.

The type of the document. Possible values: ID, DRIVINGLICENSE, PASSPORT, SOCIALSECURITY, VISA.

To delete an existing entry for a document type, send only the type field in your request.

Possible values:

• "DRIVINGLICENSE"
• "ID"
• "SOCIALSECURITY"
• "PASSPORT"
• "VISA"

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The e-mail address of the person.

The name of the person.

The gender.

The following values are permitted: MALE, FEMALE, UNKNOWN.

Possible values:

• "FEMALE"
• "MALE"
• "UNKNOWN"

The last name.

The first name.

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.

The URL of the person's website.

Specifies how the person is associated with the account holder.

Possible values:

• Owner: Individuals who directly or indirectly own 25% or more of a company.

• Controller: Individuals who are members of senior management staff responsible for managing a company or organization.

Possible values:

• "Owner"
• "Signatory"
• "Controller"

The phone number of the person.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

The unique identifier (UUID) of the shareholder entry.

If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.

If, during an Account Holder create request, a UUID is provided, the creation of Account Holder will fail with a validation Error..

If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.

If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.

Job title of the person. Required when the shareholderType is Controller.

Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.

The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

Your reference for the shareholder entry.

The address of the person.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

The registered name of the company (if it differs from the legal name of the company).

The registration number of the company.

The legal name of the company.

Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.

Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an /updateAccountHolder request.

Address of the ultimate parent company.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

Details about the ultimate parent company's business.

The registration number of the company.

The legal name of the company.

Market Identifier Code (MIC).

International Securities Identification Number (ISIN).

Stock Ticker symbol.

Market Identifier Code (MIC).

International Securities Identification Number (ISIN).

Stock Ticker symbol.

The tax ID of the company.

Signatories associated with the company. Each array entry should represent one signatory.

Contains information about the person.

Array that contains information about the person's identification document. You can submit only one entry per document type.

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The state where the document was issued (if applicable).

The number in the document.

The type of the document. Possible values: ID, DRIVINGLICENSE, PASSPORT, SOCIALSECURITY, VISA.

To delete an existing entry for a document type, send only the type field in your request.

Possible values:

• "DRIVINGLICENSE"
• "ID"
• "SOCIALSECURITY"
• "PASSPORT"
• "VISA"

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The e-mail address of the person.

The name of the person.

The gender.

The following values are permitted: MALE, FEMALE, UNKNOWN.

Possible values:

• "FEMALE"
• "MALE"
• "UNKNOWN"

The last name.

The first name.

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.

The URL of the person's website.

The phone number of the person.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

Job title of the signatory.

Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.

The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

Your reference for the signatory.

The address of the person.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

The unique identifier (UUID) of the signatory.

If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.

If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.

If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.

If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.

Date when you last reviewed the account holder's information, in ISO-8601 YYYY-MM-DD format. For example, 2020-01-31.

The address of the account holder.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

Details about the business or nonprofit account holder. Required when creating an account holder with legalEntity Business or NonProfit.

Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to our verification guide.

Contains information about the person.

Array that contains information about the person's identification document. You can submit only one entry per document type.

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The state where the document was issued (if applicable).

The number in the document.

The type of the document. Possible values: ID, DRIVINGLICENSE, PASSPORT, SOCIALSECURITY, VISA.

To delete an existing entry for a document type, send only the type field in your request.

Possible values:

• "DRIVINGLICENSE"
• "ID"
• "SOCIALSECURITY"
• "PASSPORT"
• "VISA"

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The e-mail address of the person.

The name of the person.

The gender.

The following values are permitted: MALE, FEMALE, UNKNOWN.

Possible values:

• "FEMALE"
• "MALE"
• "UNKNOWN"

The last name.

The first name.

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.

The URL of the person's website.

Specifies how the person is associated with the account holder.

Possible values:

• Owner: Individuals who directly or indirectly own 25% or more of a company.

• Controller: Individuals who are members of senior management staff responsible for managing a company or organization.

Possible values:

• "Owner"
• "Signatory"
• "Controller"

The phone number of the person.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

The unique identifier (UUID) of the shareholder entry.

If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.

If, during an Account Holder create request, a UUID is provided, the creation of Account Holder will fail with a validation Error..

If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.

If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.

Job title of the person. Required when the shareholderType is Controller.

Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.

The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

Your reference for the shareholder entry.

The address of the person.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

The registered name of the company (if it differs from the legal name of the company).

The registration number of the company.

The legal name of the company.

Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.

Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an /updateAccountHolder request.

Address of the ultimate parent company.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

Details about the ultimate parent company's business.

The registration number of the company.

The legal name of the company.

Market Identifier Code (MIC).

International Securities Identification Number (ISIN).

Stock Ticker symbol.

Market Identifier Code (MIC).

International Securities Identification Number (ISIN).

Stock Ticker symbol.

The tax ID of the company.

Signatories associated with the company. Each array entry should represent one signatory.

Contains information about the person.

Array that contains information about the person's identification document. You can submit only one entry per document type.

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The state where the document was issued (if applicable).

The number in the document.

The type of the document. Possible values: ID, DRIVINGLICENSE, PASSPORT, SOCIALSECURITY, VISA.

To delete an existing entry for a document type, send only the type field in your request.

Possible values:

• "DRIVINGLICENSE"
• "ID"
• "SOCIALSECURITY"
• "PASSPORT"
• "VISA"

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.

The e-mail address of the person.

The name of the person.

The gender.

The following values are permitted: MALE, FEMALE, UNKNOWN.

Possible values:

• "FEMALE"
• "MALE"
• "UNKNOWN"

The last name.

The first name.

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.

The URL of the person's website.

The phone number of the person.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

Job title of the signatory.

Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.

The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

Your reference for the signatory.

The address of the person.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

The unique identifier (UUID) of the signatory.

If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.

If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.

If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.

If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.

Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen point of sale.

The phone number of the store.

The type of the phone number.

The following values are permitted: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number.

The inclusion of the phone number country code is not necessary.

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

The account holder's accountCode where the split amount will be sent. Required when you provide the splitConfigurationUUID.

The status of the store. Possible values: Pending, Active, Inactive, InactiveWithModifications, Closed.

Possible values:

• "Closed"
• "Inactive"
• "Active"
• "Pending"
• "InactiveWithModifications"

The merchant account to which the store belongs.

The merchant category code (MCC) that classifies the business of the account holder.

The phone number of the store provided as a single string. It will be handled as a landline phone.

Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

Store logo for payment method setup.

The sales channel. Possible values: Ecommerce, POS.

Possible values:

• "Ecommerce"
• "POS"

URL of the ecommerce store.

The name of the account holder's store. This value is shown in shopper statements.

• Length: Between 3 to 22 characters

• The following characters are not supported: :;}{$#@!|<>%^*+=\

Note: storeName does not appear in American Express shopper statements by default. Contact Adyen Support to enable this for American Express.

Your unique identifier for the store. The Customer Area also uses this value for the store description.

• Length: Between 3 to 128 characters

• The following characters are not supported: :;}{$#@!|<>%^*+=\

Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an /updateAccountHolder request.

Merchant house number for payment method setup.

The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the virtualAccount is also required. Adyen uses the configuration and the virtualAccount to split funds between accounts in your platform.

The address of the physical store where the account holder will process payments from.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

The principal business address of the account holder.

The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.

Maximum length:

• 2 characters for addresses in the US or Canada.

• 3 characters for all other countries.

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.

The number or name of the house.

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.

The legal entity type of the account holder. This determines the information that should be provided in the request.

Possible values: Business, Individual, or NonProfit.

• If set to Business or NonProfit, then accountHolderDetails.businessDetails must be provided, with at least one entry in the accountHolderDetails.businessDetails.shareholders list.

• If set to Individual, then accountHolderDetails.individualDetails must be provided.

Possible values:

• "PublicCompany"
• "Business"
• "NonProfit"
• "Partnership"
• "Individual"

A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores _.

The starting processing tier for the prospective account holder.

If set to true, an account with the default options is automatically created for the account holder. By default, this field is set to true.

The three-character ISO currency code, with which the prospective account holder primarily deals.

The identifier of the profile that applies to this entity.

Your unique identifier for the prospective account holder. The length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.