Pricing Templates
Log in Sign up
Integrations / Adyen Account / ...

POST /updateAccountHolder

Updates the accountHolderDetails and processingTier of an account holder, and adds bank accounts and shareholders.

When updating accountHolderDetails, parameters that are not included in the request are left unchanged except for the following object:

When updating any field in the following objects, you must submit all the fields required for validation:

For example, to update the address.postalCode, you must also submit the address.country, .city, .street, .postalCode, and possibly .stateOrProvince so that the address can be validated.

To add a bank account or shareholder, provide the bank account or shareholder details without a bankAccountUUID or a shareholderCode.

Servers

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
accountHolderDetails Object No

The details to which the Account Holder should be updated.

Required if a processingTier is not provided.
accountHolderDetails.bankAggregatorDataReference String No

The opaque reference value returned by the Adyen API during bank account login.
accountHolderDetails.bankAccountDetails[] Array No

Array of bank accounts associated with the account holder. For details about the required bankAccountDetail fields, see Required information.
accountHolderDetails.bankAccountDetails[].ownerStreet String No

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

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].ownerPostalCode String No

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

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].iban String No

The international bank account number.

The IBAN standard is defined in ISO-13616.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].taxId String No

The tax ID number.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].bankBicSwift String No

The bank identifier code.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].ownerCountryCode String No

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.
accountHolderDetails.bankAccountDetails[].bankCity String No

The city in which the bank branch is located.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].bankCode String No

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

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].ownerName String No

The name of the bank account owner.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].bankAccountReference String No

Merchant reference to the bank account.
accountHolderDetails.bankAccountDetails[].accountType String No

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.
accountHolderDetails.bankAccountDetails[].ownerHouseNumberOrName String No

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

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].ownerState String No

The state of residence of the bank account owner.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].bankAccountUUID String No

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.
accountHolderDetails.bankAccountDetails[].urlForVerification String No

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.
accountHolderDetails.bankAccountDetails[].primaryAccount Boolean No

If set to true, the bank account is a primary account.
accountHolderDetails.bankAccountDetails[].bankAccountName String No

The name of the bank account.
accountHolderDetails.bankAccountDetails[].countryCode String No

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.
accountHolderDetails.bankAccountDetails[].ownerDateOfBirth String No

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).
accountHolderDetails.bankAccountDetails[].checkCode String No

The check code of the bank account.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].currencyCode String No

The currency in which the bank account deals.

The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').
accountHolderDetails.bankAccountDetails[].accountNumber String No

The bank account number (without separators).

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].bankName String No

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

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].ownerCity String No

The city of residence of the bank account owner.

Refer to Required information for details on field requirements.
accountHolderDetails.bankAccountDetails[].ownerNationality String No

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.
accountHolderDetails.bankAccountDetails[].branchCode String No

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.
accountHolderDetails.phoneNumber Object No

The phone number of the account holder.

Required if a fullPhoneNumber is not provided.
accountHolderDetails.phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

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

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.
accountHolderDetails.merchantCategoryCode String No

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).
accountHolderDetails.fullPhoneNumber String No

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"
accountHolderDetails.payoutMethods[] Array No

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.
accountHolderDetails.payoutMethods[].shopperReference String Yes

The shopperReference you sent in the /payments request when you saved the account holder's card details.
accountHolderDetails.payoutMethods[].payoutMethodCode String No

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.
accountHolderDetails.payoutMethods[].recurringDetailReference String Yes

The recurringDetailReference returned in the /payments response when you saved the account holder's card details.
accountHolderDetails.payoutMethods[].merchantAccount String Yes

The merchantAccount you used in the /payments request when you saved the account holder's card details.
accountHolderDetails.payoutMethods[].payoutMethodReference String No

Your reference for the payout method.
accountHolderDetails.email String No

The email address of the account holder.
accountHolderDetails.individualDetails Object No

Details about the individual account holder. Required when creating an account holder with legalEntity Individual.
accountHolderDetails.individualDetails.personalData Object No

Personal information of the individual.
accountHolderDetails.individualDetails.personalData.documentData[] Array No

Array that contains information about the person's identification document. You can submit only one entry per document type.
accountHolderDetails.individualDetails.personalData.documentData[].expirationDate String No

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.individualDetails.personalData.documentData[].issuerState String No

The state where the document was issued (if applicable).
accountHolderDetails.individualDetails.personalData.documentData[].number String No

The number in the document.
accountHolderDetails.individualDetails.personalData.documentData[].type String Yes

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"
accountHolderDetails.individualDetails.personalData.documentData[].issuerCountry String No

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.individualDetails.personalData.nationality String No

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

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

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.
accountHolderDetails.individualDetails.name.gender String No

The gender.

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

Possible values:

  • "FEMALE"
  • "MALE"
  • "UNKNOWN"
accountHolderDetails.individualDetails.name.lastName String No

The last name.
accountHolderDetails.individualDetails.name.firstName String No

The first name.
accountHolderDetails.individualDetails.name.infix String No

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.
accountHolderDetails.webAddress String No

The URL of the website of the account holder.
accountHolderDetails.legalArrangements[] Array No

An array containing information about the account holder's legal arrangements.
accountHolderDetails.legalArrangements[].legalArrangementReference String No

Your reference for the legal arrangement. Must be between 3 to 128 characters.
accountHolderDetails.legalArrangements[].legalForm String No

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"
accountHolderDetails.legalArrangements[].name String Yes

The legal name of the legal arrangement. Minimum length: 3 characters.
accountHolderDetails.legalArrangements[].registrationNumber String No

The registration number of the legal arrangement.
accountHolderDetails.legalArrangements[].taxNumber String No

The tax identification number of the legal arrangement.
accountHolderDetails.legalArrangements[].type String Yes

The type of legal arrangement.

Possible values:

  • Association

  • Partnership

  • SoleProprietorship

  • Trust

Possible values:

  • "SoleProprietorship"
  • "Trust"
  • "Association"
  • "Partnership"
accountHolderDetails.legalArrangements[].legalArrangementCode String No

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.
accountHolderDetails.legalArrangements[].address Object Yes

The address of the legal arrangement.
accountHolderDetails.legalArrangements[].address.postalCode String No

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.
accountHolderDetails.legalArrangements[].address.stateOrProvince String No

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.
accountHolderDetails.legalArrangements[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.legalArrangements[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[] Array No

An array containing information about other entities that are part of the legal arrangement.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].email String No

The e-mail address of the entity.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails Object No

Required when creating an entity with legalEntityType Individual.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData Object No

Personal information of the individual.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.documentData[] Array No

Array that contains information about the person's identification document. You can submit only one entry per document type.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.documentData[].expirationDate String No

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.documentData[].issuerState String No

The state where the document was issued (if applicable).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.documentData[].number String No

The number in the document.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.documentData[].type String Yes

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.documentData[].issuerCountry String No

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.nationality String No

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.personalData.dateOfBirth String No

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.name Object No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.name.gender String No

The gender.

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

Possible values:

  • "FEMALE"
  • "MALE"
  • "UNKNOWN"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.name.lastName String No

The last name.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.name.firstName String No

The first name.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].individualDetails.name.infix String No

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].webAddress String No

The URL of the website of the contact.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].legalArrangementEntityReference String No

Your reference for the legal arrangement entity.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].phoneNumber Object No

The phone number of the entity.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
accountHolderDetails.legalArrangements[].legalArrangementEntities[].legalArrangementEntityCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].legalEntityType String No

The legal entity type.

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

Possible values:

  • "PublicCompany"
  • "Business"
  • "NonProfit"
  • "Partnership"
  • "Individual"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].fullPhoneNumber String No

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].legalArrangementMembers[] Array No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address Object No

The address of the entity.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address.postalCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address.stateOrProvince String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails Object No

Required when creating an entity with legalEntityType Business, NonProfit, PublicCompany, or Partnership.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[] Array No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData Object No

Contains information about the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.documentData[] Array No

Array that contains information about the person's identification document. You can submit only one entry per document type.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.documentData[].expirationDate String No

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.documentData[].issuerState String No

The state where the document was issued (if applicable).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.documentData[].number String No

The number in the document.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.documentData[].type String Yes

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.documentData[].issuerCountry String No

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.nationality String No

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].personalData.dateOfBirth String No

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].email String No

The e-mail address of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].name Object No

The name of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].name.gender String No

The gender.

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

Possible values:

  • "FEMALE"
  • "MALE"
  • "UNKNOWN"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].name.lastName String No

The last name.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].name.firstName String No

The first name.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].name.infix String No

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].webAddress String No

The URL of the person's website.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].shareholderType String No

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].phoneNumber Object No

The phone number of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].shareholderCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].jobTitle String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].fullPhoneNumber String No

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].shareholderReference String No

Your reference for the shareholder entry.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address Object No

The address of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address.postalCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address.stateOrProvince String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.shareholders[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.doingBusinessAs String No

The registered name of the company (if it differs from the legal name of the company).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.registrationNumber String No

The registration number of the company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.legalBusinessName String No

The legal name of the company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[] Array No

Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].ultimateParentCompanyCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address Object No

Address of the ultimate parent company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address.postalCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address.stateOrProvince String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].businessDetails Object No

Details about the ultimate parent company's business.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].businessDetails.registrationNumber String No

The registration number of the company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].businessDetails.legalBusinessName String No

The legal name of the company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].businessDetails.stockExchange String No

Market Identifier Code (MIC).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].businessDetails.stockNumber String No

International Securities Identification Number (ISIN).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.listedUltimateParentCompany[].businessDetails.stockTicker String No

Stock Ticker symbol.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.stockExchange String No

Market Identifier Code (MIC).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.stockNumber String No

International Securities Identification Number (ISIN).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.stockTicker String No

Stock Ticker symbol.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.taxId String No

The tax ID of the company.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[] Array No

Signatories associated with the company. Each array entry should represent one signatory.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData Object No

Contains information about the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.documentData[] Array No

Array that contains information about the person's identification document. You can submit only one entry per document type.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.documentData[].expirationDate String No

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.documentData[].issuerState String No

The state where the document was issued (if applicable).
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.documentData[].number String No

The number in the document.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.documentData[].type String Yes

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.documentData[].issuerCountry String No

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.nationality String No

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].personalData.dateOfBirth String No

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].email String No

The e-mail address of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].name Object No

The name of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].name.gender String No

The gender.

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

Possible values:

  • "FEMALE"
  • "MALE"
  • "UNKNOWN"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].name.lastName String No

The last name.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].name.firstName String No

The first name.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].name.infix String No

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].webAddress String No

The URL of the person's website.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].phoneNumber Object No

The phone number of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].jobTitle String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].fullPhoneNumber String No

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"
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].signatoryReference String No

Your reference for the signatory.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address Object No

The address of the person.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address.postalCode String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address.stateOrProvince String No

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.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.legalArrangements[].legalArrangementEntities[].businessDetails.signatories[].signatoryCode String No

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.
accountHolderDetails.lastReviewDate String No

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

The address of the account holder.
accountHolderDetails.address.postalCode String No

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.
accountHolderDetails.address.stateOrProvince String No

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.
accountHolderDetails.address.country String Yes

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

The number or name of the house.
accountHolderDetails.address.street String No

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

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

Details about the business or nonprofit account holder. Required when creating an account holder with legalEntity Business or NonProfit.
accountHolderDetails.businessDetails.shareholders[] Array No

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.
accountHolderDetails.businessDetails.shareholders[].personalData Object No

Contains information about the person.
accountHolderDetails.businessDetails.shareholders[].personalData.documentData[] Array No

Array that contains information about the person's identification document. You can submit only one entry per document type.
accountHolderDetails.businessDetails.shareholders[].personalData.documentData[].expirationDate String No

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.businessDetails.shareholders[].personalData.documentData[].issuerState String No

The state where the document was issued (if applicable).
accountHolderDetails.businessDetails.shareholders[].personalData.documentData[].number String No

The number in the document.
accountHolderDetails.businessDetails.shareholders[].personalData.documentData[].type String Yes

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"
accountHolderDetails.businessDetails.shareholders[].personalData.documentData[].issuerCountry String No

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.shareholders[].personalData.nationality String No

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.shareholders[].personalData.dateOfBirth String No

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.businessDetails.shareholders[].email String No

The e-mail address of the person.
accountHolderDetails.businessDetails.shareholders[].name Object No

The name of the person.
accountHolderDetails.businessDetails.shareholders[].name.gender String No

The gender.

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

Possible values:

  • "FEMALE"
  • "MALE"
  • "UNKNOWN"
accountHolderDetails.businessDetails.shareholders[].name.lastName String No

The last name.
accountHolderDetails.businessDetails.shareholders[].name.firstName String No

The first name.
accountHolderDetails.businessDetails.shareholders[].name.infix String No

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.
accountHolderDetails.businessDetails.shareholders[].webAddress String No

The URL of the person's website.
accountHolderDetails.businessDetails.shareholders[].shareholderType String No

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"
accountHolderDetails.businessDetails.shareholders[].phoneNumber Object No

The phone number of the person.
accountHolderDetails.businessDetails.shareholders[].phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.businessDetails.shareholders[].phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.businessDetails.shareholders[].phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
accountHolderDetails.businessDetails.shareholders[].shareholderCode String No

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.
accountHolderDetails.businessDetails.shareholders[].jobTitle String No

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.
accountHolderDetails.businessDetails.shareholders[].fullPhoneNumber String No

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"
accountHolderDetails.businessDetails.shareholders[].shareholderReference String No

Your reference for the shareholder entry.
accountHolderDetails.businessDetails.shareholders[].address Object No

The address of the person.
accountHolderDetails.businessDetails.shareholders[].address.postalCode String No

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.
accountHolderDetails.businessDetails.shareholders[].address.stateOrProvince String No

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.
accountHolderDetails.businessDetails.shareholders[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.shareholders[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.businessDetails.shareholders[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.businessDetails.shareholders[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.businessDetails.doingBusinessAs String No

The registered name of the company (if it differs from the legal name of the company).
accountHolderDetails.businessDetails.registrationNumber String No

The registration number of the company.
accountHolderDetails.businessDetails.legalBusinessName String No

The legal name of the company.
accountHolderDetails.businessDetails.listedUltimateParentCompany[] Array No

Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].ultimateParentCompanyCode String No

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.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address Object No

Address of the ultimate parent company.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address.postalCode String No

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.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address.stateOrProvince String No

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.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].businessDetails Object No

Details about the ultimate parent company's business.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].businessDetails.registrationNumber String No

The registration number of the company.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].businessDetails.legalBusinessName String No

The legal name of the company.
accountHolderDetails.businessDetails.listedUltimateParentCompany[].businessDetails.stockExchange String No

Market Identifier Code (MIC).
accountHolderDetails.businessDetails.listedUltimateParentCompany[].businessDetails.stockNumber String No

International Securities Identification Number (ISIN).
accountHolderDetails.businessDetails.listedUltimateParentCompany[].businessDetails.stockTicker String No

Stock Ticker symbol.
accountHolderDetails.businessDetails.stockExchange String No

Market Identifier Code (MIC).
accountHolderDetails.businessDetails.stockNumber String No

International Securities Identification Number (ISIN).
accountHolderDetails.businessDetails.stockTicker String No

Stock Ticker symbol.
accountHolderDetails.businessDetails.taxId String No

The tax ID of the company.
accountHolderDetails.businessDetails.signatories[] Array No

Signatories associated with the company. Each array entry should represent one signatory.
accountHolderDetails.businessDetails.signatories[].personalData Object No

Contains information about the person.
accountHolderDetails.businessDetails.signatories[].personalData.documentData[] Array No

Array that contains information about the person's identification document. You can submit only one entry per document type.
accountHolderDetails.businessDetails.signatories[].personalData.documentData[].expirationDate String No

The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.businessDetails.signatories[].personalData.documentData[].issuerState String No

The state where the document was issued (if applicable).
accountHolderDetails.businessDetails.signatories[].personalData.documentData[].number String No

The number in the document.
accountHolderDetails.businessDetails.signatories[].personalData.documentData[].type String Yes

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"
accountHolderDetails.businessDetails.signatories[].personalData.documentData[].issuerCountry String No

The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.signatories[].personalData.nationality String No

The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.signatories[].personalData.dateOfBirth String No

The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
accountHolderDetails.businessDetails.signatories[].email String No

The e-mail address of the person.
accountHolderDetails.businessDetails.signatories[].name Object No

The name of the person.
accountHolderDetails.businessDetails.signatories[].name.gender String No

The gender.

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

Possible values:

  • "FEMALE"
  • "MALE"
  • "UNKNOWN"
accountHolderDetails.businessDetails.signatories[].name.lastName String No

The last name.
accountHolderDetails.businessDetails.signatories[].name.firstName String No

The first name.
accountHolderDetails.businessDetails.signatories[].name.infix String No

The name's infix, if applicable.

A maximum length of twenty (20) characters is imposed.
accountHolderDetails.businessDetails.signatories[].webAddress String No

The URL of the person's website.
accountHolderDetails.businessDetails.signatories[].phoneNumber Object No

The phone number of the person.
accountHolderDetails.businessDetails.signatories[].phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.businessDetails.signatories[].phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.businessDetails.signatories[].phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
accountHolderDetails.businessDetails.signatories[].jobTitle String No

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.
accountHolderDetails.businessDetails.signatories[].fullPhoneNumber String No

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"
accountHolderDetails.businessDetails.signatories[].signatoryReference String No

Your reference for the signatory.
accountHolderDetails.businessDetails.signatories[].address Object No

The address of the person.
accountHolderDetails.businessDetails.signatories[].address.postalCode String No

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.
accountHolderDetails.businessDetails.signatories[].address.stateOrProvince String No

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.
accountHolderDetails.businessDetails.signatories[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.businessDetails.signatories[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.businessDetails.signatories[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.businessDetails.signatories[].address.city String No

The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
accountHolderDetails.businessDetails.signatories[].signatoryCode String No

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.
accountHolderDetails.storeDetails[] Array No

Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen point of sale.
accountHolderDetails.storeDetails[].phoneNumber Object No

The phone number of the store.
accountHolderDetails.storeDetails[].phoneNumber.phoneType String No

The type of the phone number.

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
accountHolderDetails.storeDetails[].phoneNumber.phoneNumber String No

The phone number.

The inclusion of the phone number country code is not necessary.
accountHolderDetails.storeDetails[].phoneNumber.phoneCountryCode String No

The two-character country code of the phone number.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
accountHolderDetails.storeDetails[].virtualAccount String No

The account holder's accountCode where the split amount will be sent. Required when you provide the splitConfigurationUUID.
accountHolderDetails.storeDetails[].status String No

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

Possible values:

  • "Closed"
  • "Inactive"
  • "Active"
  • "Pending"
  • "InactiveWithModifications"
accountHolderDetails.storeDetails[].merchantAccount String Yes

The merchant account to which the store belongs.
accountHolderDetails.storeDetails[].merchantCategoryCode String Yes

The merchant category code (MCC) that classifies the business of the account holder.
accountHolderDetails.storeDetails[].fullPhoneNumber String No

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"
accountHolderDetails.storeDetails[].logo String No

Store logo for payment method setup.
accountHolderDetails.storeDetails[].shopperInteraction String No

The sales channel. Possible values: Ecommerce, POS.

Possible values:

  • "Ecommerce"
  • "POS"
accountHolderDetails.storeDetails[].webAddress String No

URL of the ecommerce store.
accountHolderDetails.storeDetails[].storeName String No

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.
accountHolderDetails.storeDetails[].storeReference String No

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: :;}{$#@!|<>%^*+=\
accountHolderDetails.storeDetails[].store String No

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.
accountHolderDetails.storeDetails[].merchantHouseNumber String No

Merchant house number for payment method setup.
accountHolderDetails.storeDetails[].splitConfigurationUUID String No

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.
accountHolderDetails.storeDetails[].address Object Yes

The address of the physical store where the account holder will process payments from.
accountHolderDetails.storeDetails[].address.postalCode String No

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.
accountHolderDetails.storeDetails[].address.stateOrProvince String No

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.
accountHolderDetails.storeDetails[].address.country String Yes

The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
accountHolderDetails.storeDetails[].address.houseNumberOrName String No

The number or name of the house.
accountHolderDetails.storeDetails[].address.street String No

The name of the street. Required if the houseNumberOrName, city, postalCode, or stateOrProvince are provided.
accountHolderDetails.storeDetails[].address.city String No

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

The principal business address of the account holder.
accountHolderDetails.principalBusinessAddress.postalCode String No

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.
accountHolderDetails.principalBusinessAddress.stateOrProvince String No

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.
accountHolderDetails.principalBusinessAddress.country String Yes

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

The number or name of the house.
accountHolderDetails.principalBusinessAddress.street String No

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

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

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"
description String No

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

The processing tier to which the Account Holder should be updated.

The processing tier can not be lowered through this request.

Required if accountHolderDetails are not provided.
primaryCurrency String No

The primary three-character ISO currency code, to which the account holder should be updated.
verificationProfile String No

The identifier of the profile that applies to this entity.
accountHolderCode String Yes

The code of the Account Holder to be updated.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2024 SimWorkflow
Terms of Service Privacy Policy