Adyen for Platforms: Account API
  1. Schemas
Adyen for Platforms: Account API
  • Verification
    • Trigger verification
    • Delete bank accounts
    • Delete legal arrangements
    • Delete payout methods
    • Delete shareholders
    • Delete signatories
    • Get documents
    • Upload a document
  • Accounts
    • Close an account
    • Create an account
    • Update an account
  • Account holders
    • Close an account holder
    • Close stores
    • Create an account holder
    • Get an account holder
    • Get a tax form
    • Suspend an account holder
    • Unsuspend an account holder
    • Update an account holder
    • Update payout or processing state
  • Schemas
    • Schemas
      • Account
      • AccountEvent
      • AccountHolderDetails
      • AccountHolderStatus
      • AccountPayoutState
      • AccountProcessingState
      • Amount
      • BankAccountDetail
      • BusinessDetails
      • CloseAccountHolderRequest
      • CloseAccountHolderResponse
      • CloseAccountRequest
      • CloseAccountResponse
      • CloseStoresRequest
      • CreateAccountHolderRequest
      • CreateAccountHolderResponse
      • CreateAccountRequest
      • CreateAccountResponse
      • DeleteBankAccountRequest
      • DeletePayoutMethodRequest
      • DeleteLegalArrangementRequest
      • DeleteShareholderRequest
      • DeleteSignatoriesRequest
      • DocumentDetail
      • ErrorFieldType
      • FieldType
      • GenericResponse
      • GetAccountHolderRequest
      • GetAccountHolderResponse
      • GetAccountHolderStatusResponse
      • GetTaxFormRequest
      • GetTaxFormResponse
      • GetUploadedDocumentsRequest
      • GetUploadedDocumentsResponse
      • IndividualDetails
      • KYCCheckResult2
      • KYCCheckStatusData
      • KYCCheckResult
      • KYCCheckSummary
      • KYCLegalArrangementCheckResult
      • KYCLegalArrangementEntityCheckResult
      • KYCPayoutMethodCheckResult
      • KYCShareholderCheckResult
      • KYCSignatoryCheckResult
      • KYCUltimateParentCompanyCheckResult
      • KYCVerificationResult2
      • LegalArrangementDetail
      • KYCVerificationResult
      • LegalArrangementEntityDetail
      • PayoutMethod
      • PayoutScheduleResponse
      • LegalArrangementRequest
      • PerformVerificationRequest
      • MigratedAccounts
      • PersonalDocumentData
      • MigratedStores
      • ServiceError
      • MigrationData
      • ShareholderContact
      • SignatoryContact
      • StoreDetail
      • SuspendAccountHolderRequest
      • SuspendAccountHolderResponse
      • UltimateParentCompany
      • UltimateParentCompanyBusinessDetails
      • UnSuspendAccountHolderRequest
      • UnSuspendAccountHolderResponse
      • UpdateAccountHolderRequest
      • UpdateAccountHolderResponse
      • UpdateAccountHolderStateRequest
      • UpdateAccountRequest
      • UpdateAccountResponse
      • UpdatePayoutScheduleRequest
      • UploadDocumentRequest
      • ViasAddress
      • ViasName
      • ViasPersonalData
      • ViasPhoneNumber
  1. Schemas

UpdateAccountHolderRequest

{
    "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"
    },
    "description": "string",
    "legalEntity": "Business",
    "primaryCurrency": "string",
    "processingTier": 0,
    "verificationProfile": "string"
}
Built with