Adyen for Platforms: Account API
  1. Account holders
Adyen for Platforms: Account API
  • Verification
    • Trigger verification
      POST
    • Delete bank accounts
      POST
    • Delete legal arrangements
      POST
    • Delete payout methods
      POST
    • Delete shareholders
      POST
    • Delete signatories
      POST
    • Get documents
      POST
    • Upload a document
      POST
  • Accounts
    • Close an account
      POST
    • Create an account
      POST
    • Update an account
      POST
  • Account holders
    • Close an account holder
      POST
    • Close stores
      POST
    • Create an account holder
      POST
    • Get an account holder
      POST
    • Get a tax form
      POST
    • Suspend an account holder
      POST
    • Unsuspend an account holder
      POST
    • Update an account holder
      POST
    • Update payout or processing state
      POST
  1. Account holders

Create an account holder

POST
/createAccountHolder
Account holders
Creates an account holder that represents the sub-merchant's entity in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to Account holder and accounts.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/createAccountHolder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string",
    "accountHolderDetails": {
        "address": {
            "city": "string",
            "country": "string",
            "houseNumberOrName": "string",
            "postalCode": "string",
            "stateOrProvince": "string",
            "street": "string"
        },
        "bankAccountDetails": [
            {
                "accountNumber": "string",
                "accountType": "string",
                "bankAccountName": "string",
                "bankAccountReference": "string",
                "bankAccountUUID": "string",
                "bankBicSwift": "string",
                "bankCity": "string",
                "bankCode": "string",
                "bankName": "string",
                "branchCode": "string",
                "checkCode": "string",
                "countryCode": "string",
                "currencyCode": "string",
                "iban": "string",
                "ownerCity": "string",
                "ownerCountryCode": "string",
                "ownerDateOfBirth": "string",
                "ownerHouseNumberOrName": "string",
                "ownerName": "string",
                "ownerNationality": "string",
                "ownerPostalCode": "string",
                "ownerState": "string",
                "ownerStreet": "string",
                "primaryAccount": true,
                "taxId": "string",
                "urlForVerification": "string"
            }
        ],
        "bankAggregatorDataReference": "string",
        "businessDetails": {
            "doingBusinessAs": "string",
            "legalBusinessName": "string",
            "listedUltimateParentCompany": [
                {
                    "address": {
                        "city": "string",
                        "country": "string",
                        "houseNumberOrName": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string",
                        "street": "string"
                    },
                    "businessDetails": {
                        "legalBusinessName": "string",
                        "registrationNumber": "string",
                        "stockExchange": "string",
                        "stockNumber": "string",
                        "stockTicker": "string"
                    },
                    "ultimateParentCompanyCode": "string"
                }
            ],
            "registrationNumber": "string",
            "shareholders": [
                {
                    "address": {
                        "city": "string",
                        "country": "string",
                        "houseNumberOrName": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string",
                        "street": "string"
                    },
                    "email": "string",
                    "fullPhoneNumber": "string",
                    "jobTitle": "string",
                    "name": {
                        "firstName": "string",
                        "gender": "MALE",
                        "infix": "string",
                        "lastName": "string"
                    },
                    "personalData": {
                        "dateOfBirth": "string",
                        "documentData": [
                            {
                                "expirationDate": "string",
                                "issuerCountry": "st",
                                "issuerState": "string",
                                "number": "string",
                                "type": "DRIVINGLICENSE"
                            }
                        ],
                        "nationality": "st"
                    },
                    "phoneNumber": {
                        "phoneCountryCode": "string",
                        "phoneNumber": "string",
                        "phoneType": "Fax"
                    },
                    "shareholderCode": "string",
                    "shareholderReference": "string",
                    "shareholderType": "Controller",
                    "webAddress": "string"
                }
            ],
            "signatories": [
                {
                    "address": {
                        "city": "string",
                        "country": "string",
                        "houseNumberOrName": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string",
                        "street": "string"
                    },
                    "email": "string",
                    "fullPhoneNumber": "string",
                    "jobTitle": "string",
                    "name": {
                        "firstName": "string",
                        "gender": "MALE",
                        "infix": "string",
                        "lastName": "string"
                    },
                    "personalData": {
                        "dateOfBirth": "string",
                        "documentData": [
                            {
                                "expirationDate": "string",
                                "issuerCountry": "st",
                                "issuerState": "string",
                                "number": "string",
                                "type": "DRIVINGLICENSE"
                            }
                        ],
                        "nationality": "st"
                    },
                    "phoneNumber": {
                        "phoneCountryCode": "string",
                        "phoneNumber": "string",
                        "phoneType": "Fax"
                    },
                    "signatoryCode": "string",
                    "signatoryReference": "string",
                    "webAddress": "string"
                }
            ],
            "stockExchange": "string",
            "stockNumber": "string",
            "stockTicker": "string",
            "taxId": "string"
        },
        "email": "string",
        "fullPhoneNumber": "string",
        "individualDetails": {
            "name": {
                "firstName": "string",
                "gender": "MALE",
                "infix": "string",
                "lastName": "string"
            },
            "personalData": {
                "dateOfBirth": "string",
                "documentData": [
                    {
                        "expirationDate": "string",
                        "issuerCountry": "st",
                        "issuerState": "string",
                        "number": "string",
                        "type": "DRIVINGLICENSE"
                    }
                ],
                "nationality": "st"
            }
        },
        "lastReviewDate": "string",
        "legalArrangements": [
            {
                "address": {
                    "city": "string",
                    "country": "string",
                    "houseNumberOrName": "string",
                    "postalCode": "string",
                    "stateOrProvince": "string",
                    "street": "string"
                },
                "legalArrangementCode": "string",
                "legalArrangementEntities": [
                    {
                        "address": {
                            "city": "string",
                            "country": "string",
                            "houseNumberOrName": "string",
                            "postalCode": "string",
                            "stateOrProvince": "string",
                            "street": "string"
                        },
                        "businessDetails": {
                            "doingBusinessAs": "string",
                            "legalBusinessName": "string",
                            "listedUltimateParentCompany": [
                                {
                                    "address": {
                                        "city": "string",
                                        "country": "string",
                                        "houseNumberOrName": "string",
                                        "postalCode": "string",
                                        "stateOrProvince": "string",
                                        "street": "string"
                                    },
                                    "businessDetails": {
                                        "legalBusinessName": "string",
                                        "registrationNumber": "string",
                                        "stockExchange": "string",
                                        "stockNumber": "string",
                                        "stockTicker": "string"
                                    },
                                    "ultimateParentCompanyCode": "string"
                                }
                            ],
                            "registrationNumber": "string",
                            "shareholders": [
                                {
                                    "address": {
                                        "city": "string",
                                        "country": "string",
                                        "houseNumberOrName": "string",
                                        "postalCode": "string",
                                        "stateOrProvince": "string",
                                        "street": "string"
                                    },
                                    "email": "string",
                                    "fullPhoneNumber": "string",
                                    "jobTitle": "string",
                                    "name": {
                                        "firstName": "string",
                                        "gender": "MALE",
                                        "infix": "string",
                                        "lastName": "string"
                                    },
                                    "personalData": {
                                        "dateOfBirth": "string",
                                        "documentData": [
                                            {
                                                "expirationDate": "string",
                                                "issuerCountry": "st",
                                                "issuerState": "string",
                                                "number": "string",
                                                "type": "DRIVINGLICENSE"
                                            }
                                        ],
                                        "nationality": "st"
                                    },
                                    "phoneNumber": {
                                        "phoneCountryCode": "string",
                                        "phoneNumber": "string",
                                        "phoneType": "Fax"
                                    },
                                    "shareholderCode": "string",
                                    "shareholderReference": "string",
                                    "shareholderType": "Controller",
                                    "webAddress": "string"
                                }
                            ],
                            "signatories": [
                                {
                                    "address": {
                                        "city": "string",
                                        "country": "string",
                                        "houseNumberOrName": "string",
                                        "postalCode": "string",
                                        "stateOrProvince": "string",
                                        "street": "string"
                                    },
                                    "email": "string",
                                    "fullPhoneNumber": "string",
                                    "jobTitle": "string",
                                    "name": {
                                        "firstName": "string",
                                        "gender": "MALE",
                                        "infix": "string",
                                        "lastName": "string"
                                    },
                                    "personalData": {
                                        "dateOfBirth": "string",
                                        "documentData": [
                                            {
                                                "expirationDate": "string",
                                                "issuerCountry": "st",
                                                "issuerState": "string",
                                                "number": "string",
                                                "type": "DRIVINGLICENSE"
                                            }
                                        ],
                                        "nationality": "st"
                                    },
                                    "phoneNumber": {
                                        "phoneCountryCode": "string",
                                        "phoneNumber": "string",
                                        "phoneType": "Fax"
                                    },
                                    "signatoryCode": "string",
                                    "signatoryReference": "string",
                                    "webAddress": "string"
                                }
                            ],
                            "stockExchange": "string",
                            "stockNumber": "string",
                            "stockTicker": "string",
                            "taxId": "string"
                        },
                        "email": "string",
                        "fullPhoneNumber": "string",
                        "individualDetails": {
                            "name": {
                                "firstName": "string",
                                "gender": "MALE",
                                "infix": "string",
                                "lastName": "string"
                            },
                            "personalData": {
                                "dateOfBirth": "string",
                                "documentData": [
                                    {
                                        "expirationDate": "string",
                                        "issuerCountry": "st",
                                        "issuerState": "string",
                                        "number": "string",
                                        "type": "DRIVINGLICENSE"
                                    }
                                ],
                                "nationality": "st"
                            }
                        },
                        "legalArrangementEntityCode": "string",
                        "legalArrangementEntityReference": "string",
                        "legalArrangementMembers": [
                            "Beneficiary"
                        ],
                        "legalEntityType": "Business",
                        "phoneNumber": {
                            "phoneCountryCode": "string",
                            "phoneNumber": "string",
                            "phoneType": "Fax"
                        },
                        "webAddress": "string"
                    }
                ],
                "legalArrangementReference": "string",
                "legalForm": "CashManagementTrust",
                "name": "string",
                "registrationNumber": "string",
                "taxNumber": "string",
                "type": "Association"
            }
        ],
        "merchantCategoryCode": "string",
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "payoutMethods": [
            {
                "merchantAccount": "string",
                "payoutMethodCode": "string",
                "payoutMethodReference": "string",
                "recurringDetailReference": "string",
                "shopperReference": "string"
            }
        ],
        "principalBusinessAddress": {
            "city": "string",
            "country": "string",
            "houseNumberOrName": "string",
            "postalCode": "string",
            "stateOrProvince": "string",
            "street": "string"
        },
        "storeDetails": [
            {
                "address": {
                    "city": "string",
                    "country": "string",
                    "houseNumberOrName": "string",
                    "postalCode": "string",
                    "stateOrProvince": "string",
                    "street": "string"
                },
                "fullPhoneNumber": "string",
                "logo": "string",
                "merchantAccount": "string",
                "merchantCategoryCode": "string",
                "merchantHouseNumber": "string",
                "phoneNumber": {
                    "phoneCountryCode": "string",
                    "phoneNumber": "string",
                    "phoneType": "Fax"
                },
                "shopperInteraction": "Ecommerce",
                "splitConfigurationUUID": "string",
                "status": "Active",
                "store": "string",
                "storeName": "string",
                "storeReference": "string",
                "virtualAccount": "string",
                "webAddress": "string"
            }
        ],
        "webAddress": "string"
    },
    "createDefaultAccount": true,
    "description": "string",
    "legalEntity": "Business",
    "primaryCurrency": "string",
    "processingTier": 0,
    "verificationProfile": "string"
}'
Response Response Example
200 - Example 1
{
    "accountCode": "string",
    "accountHolderCode": "string",
    "accountHolderDetails": {
        "address": {
            "city": "string",
            "country": "string",
            "houseNumberOrName": "string",
            "postalCode": "string",
            "stateOrProvince": "string",
            "street": "string"
        },
        "bankAccountDetails": [
            {
                "accountNumber": "string",
                "accountType": "string",
                "bankAccountName": "string",
                "bankAccountReference": "string",
                "bankAccountUUID": "string",
                "bankBicSwift": "string",
                "bankCity": "string",
                "bankCode": "string",
                "bankName": "string",
                "branchCode": "string",
                "checkCode": "string",
                "countryCode": "string",
                "currencyCode": "string",
                "iban": "string",
                "ownerCity": "string",
                "ownerCountryCode": "string",
                "ownerDateOfBirth": "string",
                "ownerHouseNumberOrName": "string",
                "ownerName": "string",
                "ownerNationality": "string",
                "ownerPostalCode": "string",
                "ownerState": "string",
                "ownerStreet": "string",
                "primaryAccount": true,
                "taxId": "string",
                "urlForVerification": "string"
            }
        ],
        "bankAggregatorDataReference": "string",
        "businessDetails": {
            "doingBusinessAs": "string",
            "legalBusinessName": "string",
            "listedUltimateParentCompany": [
                {
                    "address": {
                        "city": "string",
                        "country": "string",
                        "houseNumberOrName": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string",
                        "street": "string"
                    },
                    "businessDetails": {
                        "legalBusinessName": "string",
                        "registrationNumber": "string",
                        "stockExchange": "string",
                        "stockNumber": "string",
                        "stockTicker": "string"
                    },
                    "ultimateParentCompanyCode": "string"
                }
            ],
            "registrationNumber": "string",
            "shareholders": [
                {
                    "address": {
                        "city": "string",
                        "country": "string",
                        "houseNumberOrName": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string",
                        "street": "string"
                    },
                    "email": "string",
                    "fullPhoneNumber": "string",
                    "jobTitle": "string",
                    "name": {
                        "firstName": "string",
                        "gender": "MALE",
                        "infix": "string",
                        "lastName": "string"
                    },
                    "personalData": {
                        "dateOfBirth": "string",
                        "documentData": [
                            {
                                "expirationDate": "string",
                                "issuerCountry": "st",
                                "issuerState": "string",
                                "number": "string",
                                "type": "DRIVINGLICENSE"
                            }
                        ],
                        "nationality": "st"
                    },
                    "phoneNumber": {
                        "phoneCountryCode": "string",
                        "phoneNumber": "string",
                        "phoneType": "Fax"
                    },
                    "shareholderCode": "string",
                    "shareholderReference": "string",
                    "shareholderType": "Controller",
                    "webAddress": "string"
                }
            ],
            "signatories": [
                {
                    "address": {
                        "city": "string",
                        "country": "string",
                        "houseNumberOrName": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string",
                        "street": "string"
                    },
                    "email": "string",
                    "fullPhoneNumber": "string",
                    "jobTitle": "string",
                    "name": {
                        "firstName": "string",
                        "gender": "MALE",
                        "infix": "string",
                        "lastName": "string"
                    },
                    "personalData": {
                        "dateOfBirth": "string",
                        "documentData": [
                            {
                                "expirationDate": "string",
                                "issuerCountry": "st",
                                "issuerState": "string",
                                "number": "string",
                                "type": "DRIVINGLICENSE"
                            }
                        ],
                        "nationality": "st"
                    },
                    "phoneNumber": {
                        "phoneCountryCode": "string",
                        "phoneNumber": "string",
                        "phoneType": "Fax"
                    },
                    "signatoryCode": "string",
                    "signatoryReference": "string",
                    "webAddress": "string"
                }
            ],
            "stockExchange": "string",
            "stockNumber": "string",
            "stockTicker": "string",
            "taxId": "string"
        },
        "email": "string",
        "fullPhoneNumber": "string",
        "individualDetails": {
            "name": {
                "firstName": "string",
                "gender": "MALE",
                "infix": "string",
                "lastName": "string"
            },
            "personalData": {
                "dateOfBirth": "string",
                "documentData": [
                    {
                        "expirationDate": "string",
                        "issuerCountry": "st",
                        "issuerState": "string",
                        "number": "string",
                        "type": "DRIVINGLICENSE"
                    }
                ],
                "nationality": "st"
            }
        },
        "lastReviewDate": "string",
        "legalArrangements": [
            {
                "address": {
                    "city": "string",
                    "country": "string",
                    "houseNumberOrName": "string",
                    "postalCode": "string",
                    "stateOrProvince": "string",
                    "street": "string"
                },
                "legalArrangementCode": "string",
                "legalArrangementEntities": [
                    {
                        "address": {
                            "city": "string",
                            "country": "string",
                            "houseNumberOrName": "string",
                            "postalCode": "string",
                            "stateOrProvince": "string",
                            "street": "string"
                        },
                        "businessDetails": {
                            "doingBusinessAs": "string",
                            "legalBusinessName": "string",
                            "listedUltimateParentCompany": [
                                {
                                    "address": {
                                        "city": "string",
                                        "country": "string",
                                        "houseNumberOrName": "string",
                                        "postalCode": "string",
                                        "stateOrProvince": "string",
                                        "street": "string"
                                    },
                                    "businessDetails": {
                                        "legalBusinessName": "string",
                                        "registrationNumber": "string",
                                        "stockExchange": "string",
                                        "stockNumber": "string",
                                        "stockTicker": "string"
                                    },
                                    "ultimateParentCompanyCode": "string"
                                }
                            ],
                            "registrationNumber": "string",
                            "shareholders": [
                                {
                                    "address": {
                                        "city": "string",
                                        "country": "string",
                                        "houseNumberOrName": "string",
                                        "postalCode": "string",
                                        "stateOrProvince": "string",
                                        "street": "string"
                                    },
                                    "email": "string",
                                    "fullPhoneNumber": "string",
                                    "jobTitle": "string",
                                    "name": {
                                        "firstName": "string",
                                        "gender": "MALE",
                                        "infix": "string",
                                        "lastName": "string"
                                    },
                                    "personalData": {
                                        "dateOfBirth": "string",
                                        "documentData": [
                                            {
                                                "expirationDate": "string",
                                                "issuerCountry": "st",
                                                "issuerState": "string",
                                                "number": "string",
                                                "type": "DRIVINGLICENSE"
                                            }
                                        ],
                                        "nationality": "st"
                                    },
                                    "phoneNumber": {
                                        "phoneCountryCode": "string",
                                        "phoneNumber": "string",
                                        "phoneType": "Fax"
                                    },
                                    "shareholderCode": "string",
                                    "shareholderReference": "string",
                                    "shareholderType": "Controller",
                                    "webAddress": "string"
                                }
                            ],
                            "signatories": [
                                {
                                    "address": {
                                        "city": "string",
                                        "country": "string",
                                        "houseNumberOrName": "string",
                                        "postalCode": "string",
                                        "stateOrProvince": "string",
                                        "street": "string"
                                    },
                                    "email": "string",
                                    "fullPhoneNumber": "string",
                                    "jobTitle": "string",
                                    "name": {
                                        "firstName": "string",
                                        "gender": "MALE",
                                        "infix": "string",
                                        "lastName": "string"
                                    },
                                    "personalData": {
                                        "dateOfBirth": "string",
                                        "documentData": [
                                            {
                                                "expirationDate": "string",
                                                "issuerCountry": "st",
                                                "issuerState": "string",
                                                "number": "string",
                                                "type": "DRIVINGLICENSE"
                                            }
                                        ],
                                        "nationality": "st"
                                    },
                                    "phoneNumber": {
                                        "phoneCountryCode": "string",
                                        "phoneNumber": "string",
                                        "phoneType": "Fax"
                                    },
                                    "signatoryCode": "string",
                                    "signatoryReference": "string",
                                    "webAddress": "string"
                                }
                            ],
                            "stockExchange": "string",
                            "stockNumber": "string",
                            "stockTicker": "string",
                            "taxId": "string"
                        },
                        "email": "string",
                        "fullPhoneNumber": "string",
                        "individualDetails": {
                            "name": {
                                "firstName": "string",
                                "gender": "MALE",
                                "infix": "string",
                                "lastName": "string"
                            },
                            "personalData": {
                                "dateOfBirth": "string",
                                "documentData": [
                                    {
                                        "expirationDate": "string",
                                        "issuerCountry": "st",
                                        "issuerState": "string",
                                        "number": "string",
                                        "type": "DRIVINGLICENSE"
                                    }
                                ],
                                "nationality": "st"
                            }
                        },
                        "legalArrangementEntityCode": "string",
                        "legalArrangementEntityReference": "string",
                        "legalArrangementMembers": [
                            "Beneficiary"
                        ],
                        "legalEntityType": "Business",
                        "phoneNumber": {
                            "phoneCountryCode": "string",
                            "phoneNumber": "string",
                            "phoneType": "Fax"
                        },
                        "webAddress": "string"
                    }
                ],
                "legalArrangementReference": "string",
                "legalForm": "CashManagementTrust",
                "name": "string",
                "registrationNumber": "string",
                "taxNumber": "string",
                "type": "Association"
            }
        ],
        "merchantCategoryCode": "string",
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "payoutMethods": [
            {
                "merchantAccount": "string",
                "payoutMethodCode": "string",
                "payoutMethodReference": "string",
                "recurringDetailReference": "string",
                "shopperReference": "string"
            }
        ],
        "principalBusinessAddress": {
            "city": "string",
            "country": "string",
            "houseNumberOrName": "string",
            "postalCode": "string",
            "stateOrProvince": "string",
            "street": "string"
        },
        "storeDetails": [
            {
                "address": {
                    "city": "string",
                    "country": "string",
                    "houseNumberOrName": "string",
                    "postalCode": "string",
                    "stateOrProvince": "string",
                    "street": "string"
                },
                "fullPhoneNumber": "string",
                "logo": "string",
                "merchantAccount": "string",
                "merchantCategoryCode": "string",
                "merchantHouseNumber": "string",
                "phoneNumber": {
                    "phoneCountryCode": "string",
                    "phoneNumber": "string",
                    "phoneType": "Fax"
                },
                "shopperInteraction": "Ecommerce",
                "splitConfigurationUUID": "string",
                "status": "Active",
                "store": "string",
                "storeName": "string",
                "storeReference": "string",
                "virtualAccount": "string",
                "webAddress": "string"
            }
        ],
        "webAddress": "string"
    },
    "accountHolderStatus": {
        "events": [
            {
                "event": "InactivateAccount",
                "executionDate": "2019-08-24T14:15:22Z",
                "reason": "string"
            }
        ],
        "payoutState": {
            "allowPayout": true,
            "disableReason": "string",
            "disabled": true,
            "notAllowedReason": "string",
            "payoutLimit": {
                "currency": "str",
                "value": 0
            },
            "tierNumber": 0
        },
        "processingState": {
            "disableReason": "string",
            "disabled": true,
            "processedFrom": {
                "currency": "str",
                "value": 0
            },
            "processedTo": {
                "currency": "str",
                "value": 0
            },
            "tierNumber": 0
        },
        "status": "Active",
        "statusReason": "string"
    },
    "description": "string",
    "invalidFields": [
        {
            "errorCode": 0,
            "errorDescription": "string",
            "fieldType": {
                "field": "string",
                "fieldName": "accountCode",
                "shareholderCode": "string"
            }
        }
    ],
    "legalEntity": "Business",
    "primaryCurrency": "string",
    "pspReference": "string",
    "resultCode": "string",
    "verification": {
        "accountHolder": {
            "checks": [
                {
                    "requiredFields": [
                        "string"
                    ],
                    "status": "AWAITING_DATA",
                    "summary": {
                        "kycCheckCode": 0,
                        "kycCheckDescription": "string"
                    },
                    "type": "BANK_ACCOUNT_VERIFICATION"
                }
            ]
        },
        "legalArrangements": [
            {
                "checks": [
                    {
                        "requiredFields": [
                            "string"
                        ],
                        "status": "AWAITING_DATA",
                        "summary": {
                            "kycCheckCode": 0,
                            "kycCheckDescription": "string"
                        },
                        "type": "BANK_ACCOUNT_VERIFICATION"
                    }
                ],
                "legalArrangementCode": "string"
            }
        ],
        "legalArrangementsEntities": [
            {
                "checks": [
                    {
                        "requiredFields": [
                            "string"
                        ],
                        "status": "AWAITING_DATA",
                        "summary": {
                            "kycCheckCode": 0,
                            "kycCheckDescription": "string"
                        },
                        "type": "BANK_ACCOUNT_VERIFICATION"
                    }
                ],
                "legalArrangementCode": "string",
                "legalArrangementEntityCode": "string"
            }
        ],
        "payoutMethods": [
            {
                "checks": [
                    {
                        "requiredFields": [
                            "string"
                        ],
                        "status": "AWAITING_DATA",
                        "summary": {
                            "kycCheckCode": 0,
                            "kycCheckDescription": "string"
                        },
                        "type": "BANK_ACCOUNT_VERIFICATION"
                    }
                ],
                "payoutMethodCode": "string"
            }
        ],
        "shareholders": [
            {
                "checks": [
                    {
                        "requiredFields": [
                            "string"
                        ],
                        "status": "AWAITING_DATA",
                        "summary": {
                            "kycCheckCode": 0,
                            "kycCheckDescription": "string"
                        },
                        "type": "BANK_ACCOUNT_VERIFICATION"
                    }
                ],
                "legalArrangementCode": "string",
                "legalArrangementEntityCode": "string",
                "shareholderCode": "string"
            }
        ],
        "signatories": [
            {
                "checks": [
                    {
                        "requiredFields": [
                            "string"
                        ],
                        "status": "AWAITING_DATA",
                        "summary": {
                            "kycCheckCode": 0,
                            "kycCheckDescription": "string"
                        },
                        "type": "BANK_ACCOUNT_VERIFICATION"
                    }
                ],
                "signatoryCode": "string"
            }
        ],
        "ultimateParentCompany": [
            {
                "checks": [
                    {
                        "requiredFields": [
                            "string"
                        ],
                        "status": "AWAITING_DATA",
                        "summary": {
                            "kycCheckCode": 0,
                            "kycCheckDescription": "string"
                        },
                        "type": "BANK_ACCOUNT_VERIFICATION"
                    }
                ],
                "ultimateParentCompanyCode": "string"
            }
        ]
    },
    "verificationProfile": "string"
}

Request

Body Params application/json
accountHolderCode
string 
required
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.
accountHolderDetails
object (AccountHolderDetails) 
required
The details of the prospective account holder.
address
object (ViasAddress) 
optional
The address of the account holder.
bankAccountDetails
array[object (BankAccountDetail) {26}] 
optional
Array of bank accounts associated with the account holder. For details about the required bankAccountDetail fields, see Required information.
bankAggregatorDataReference
string 
optional
The opaque reference value returned by the Adyen API during bank account login.
businessDetails
object (BusinessDetails) 
optional
Details about the business or nonprofit account holder.
Required when creating an account holder with legalEntity Business or NonProfit.
email
string 
optional
The email address of the account holder.
fullPhoneNumber
string 
optional
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"
individualDetails
object (IndividualDetails) 
optional
Details about the individual account holder.
Required when creating an account holder with legalEntity Individual.
lastReviewDate
string 
optional
Date when you last reviewed the account holder's information, in ISO-8601 YYYY-MM-DD format. For example, 2020-01-31.
legalArrangements
array[object (LegalArrangementDetail) {9}] 
optional
An array containing information about the account holder's legal arrangements.
merchantCategoryCode
string 
optional
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).
metadata
object 
optional
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.
payoutMethods
array[object (PayoutMethod) {5}] 
optional
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.
principalBusinessAddress
object (ViasAddress) 
optional
The principal business address of the account holder.
storeDetails
array[object (StoreDetail) {15}] 
optional
Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen point of sale.
webAddress
string 
optional
The URL of the website of the account holder.
createDefaultAccount
boolean 
optional
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.
description
string 
optional
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 _.
legalEntity
enum<string> 
required
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.
Allowed values:
BusinessIndividualNonProfitPartnershipPublicCompany
primaryCurrency
string 
deprecated
The three-character ISO currency code, with which the prospective account holder primarily deals.
processingTier
integer <int32>
optional
The starting processing tier for the prospective account holder.
verificationProfile
string 
optional
The identifier of the profile that applies to this entity.
Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body
accountCode
string 
optional
The code of a new account created for the account holder.
accountHolderCode
string 
optional
The code of the new account holder.
accountHolderDetails
object (AccountHolderDetails) 
optional
Details of the new account holder.
address
object (ViasAddress) 
optional
The address of the account holder.
bankAccountDetails
array[object (BankAccountDetail) {26}] 
optional
Array of bank accounts associated with the account holder. For details about the required bankAccountDetail fields, see Required information.
bankAggregatorDataReference
string 
optional
The opaque reference value returned by the Adyen API during bank account login.
businessDetails
object (BusinessDetails) 
optional
Details about the business or nonprofit account holder.
Required when creating an account holder with legalEntity Business or NonProfit.
email
string 
optional
The email address of the account holder.
fullPhoneNumber
string 
optional
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"
individualDetails
object (IndividualDetails) 
optional
Details about the individual account holder.
Required when creating an account holder with legalEntity Individual.
lastReviewDate
string 
optional
Date when you last reviewed the account holder's information, in ISO-8601 YYYY-MM-DD format. For example, 2020-01-31.
legalArrangements
array[object (LegalArrangementDetail) {9}] 
optional
An array containing information about the account holder's legal arrangements.
merchantCategoryCode
string 
optional
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).
metadata
object 
optional
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.
payoutMethods
array[object (PayoutMethod) {5}] 
optional
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.
principalBusinessAddress
object (ViasAddress) 
optional
The principal business address of the account holder.
storeDetails
array[object (StoreDetail) {15}] 
optional
Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen point of sale.
webAddress
string 
optional
The URL of the website of the account holder.
accountHolderStatus
object (AccountHolderStatus) 
optional
The status of the new account holder.
events
array[object (AccountEvent) {3}] 
optional
A list of events scheduled for the account holder.
payoutState
object (AccountPayoutState) 
optional
The payout state of the account holder.
processingState
object (AccountProcessingState) 
optional
The processing state of the account holder.
status
enum<string> 
required
The status of the account holder.
Permitted values: Active, Inactive, Suspended, Closed.
Allowed values:
ActiveClosedInactiveSuspended
statusReason
string 
optional
The reason why the status was assigned to the account holder.
description
string 
optional
The description of the new account holder.
invalidFields
array[object (ErrorFieldType) {3}] 
optional
A list of fields that caused the /createAccountHolder request to fail.
errorCode
integer <int32>
optional
The validation error code.
errorDescription
string 
optional
A description of the validation error.
fieldType
object (FieldType) 
optional
The type of error field.
legalEntity
enum<string> 
optional
The type of legal entity of the new account holder.
Allowed values:
BusinessIndividualNonProfitPartnershipPublicCompany
primaryCurrency
string 
deprecated
The three-character ISO currency code, with which the prospective account holder primarily deals.
pspReference
string 
optional
The reference of a request. Can be used to uniquely identify the request.
resultCode
string 
optional
The result code.
verification
object (KYCVerificationResult) 
optional
The details of KYC Verification of the account holder.
accountHolder
object (KYCCheckResult) 
optional
The results of the checks on the account holder.
legalArrangements
array[object (KYCLegalArrangementCheckResult) {2}] 
optional
The results of the checks on the legal arrangements.
legalArrangementsEntities
array[object (KYCLegalArrangementEntityCheckResult) {3}] 
optional
The results of the checks on the legal arrangement entities.
payoutMethods
array[object (KYCPayoutMethodCheckResult) {2}] 
optional
The results of the checks on the payout methods.
shareholders
array[object (KYCShareholderCheckResult) {4}] 
optional
The results of the checks on the shareholders.
signatories
array[object (KYCSignatoryCheckResult) {2}] 
optional
The results of the checks on the signatories.
ultimateParentCompany
array[object (KYCUltimateParentCompanyCheckResult) {2}] 
optional
The result of the check on the Ultimate Parent Company.
verificationProfile
string 
optional
The identifier of the profile that applies to this entity.
🟠400Bad Request - a problem reading or understanding the request.
🟠401Unauthorized - authentication required.
🟠403Forbidden - insufficient permissions to process the request.
🟠422Unprocessable Entity - a request validation error.
🔴500Internal Server Error - the server could not process the request.
Previous
Close stores
Next
Get an account holder
Built with