Get an account holder
POST
/getAccountHolder
Account holders
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/getAccountHolder' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountCode": "string",
"accountHolderCode": "string",
"showDetails": true
}'Response Response Example
200 - Example 1
{
"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"
},
"accounts": [
{
"accountCode": "string",
"bankAccountUUID": "string",
"beneficiaryAccount": "string",
"beneficiaryMerchantReference": "string",
"description": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"payoutMethodCode": "string",
"payoutSchedule": {
"nextScheduledPayout": "2019-08-24T14:15:22Z",
"schedule": "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT"
},
"payoutSpeed": "INSTANT",
"status": "string"
}
],
"description": "string",
"invalidFields": [
{
"errorCode": 0,
"errorDescription": "string",
"fieldType": {
"field": "string",
"fieldName": "accountCode",
"shareholderCode": "string"
}
}
],
"legalEntity": "Business",
"migrationData": {
"accountHolderId": "string",
"balancePlatform": "string",
"migrated": true,
"migratedAccounts": [
{
"balanceAccountId": "string",
"virtualAccountCode": "string"
}
],
"migratedStores": [
{
"businessLineId": "string",
"storeCode": "string",
"storeId": "string",
"storeReference": "string"
}
],
"migrationDate": "2019-08-24T14:15:22Z"
},
"primaryCurrency": "string",
"pspReference": "string",
"resultCode": "string",
"systemUpToDateTime": "2019-08-24T14:15:22Z",
"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