Fetch Constant Enums

The Fetch Corporate Constants request returns acceptable values of various fields that need to be passed via the Customer Onboarding v5 request.

Constants endpoint

You need to integrate this API as part of your onboarding process. You need to also display its output to your customers as a dropdown list while they complete your onboarding form. Use this API for all the fields listed below.

fieldName to category

Pass the fieldName as the category listed in the table below.

The following are the categories in Fetch Corporate Constants API.

Fetch Corporate Constants API category	Onboard Customer v5 API fieldName
annualTurnover	sizeOfBusiness.annualTurnover
averageTransactionValue	expectedAccountUsage.debit.averageTransactionValue expectedAccountUsage.credit.averageTransactionValue
businessType	businessType stakeholders.corporate[*].businessType
capitalContribution	applicant.positions[*].capitalContribution stakeholders.individual[*].positions[*].capitalContribution stakeholders.corporate[*].positions[*].capitalContribution
countryName	addresses.businessAddress.country addresses.registeredAddress.country applicant.address.country stakeholders.individual[*].address.country stakeholders.corporate[*].registeredCountry natureOfBusiness.operatingCountries[*] expectedAccountUsage.debit.topTransactionCountries[*] expectedAccountUsage.credit.topTransactionCountries[*]
countryOfOperation	natureOfBusiness.operatingCountries[*] expectedAccountUsage.debit.topTransactionCountries[*] expectedAccountUsage.credit.topTransactionCountries[*]
documentType	documents[*].type applicant.documents[*].type stakeholders.individual[*].documents[*].type
intendedUseOfAccount	expectedAccountUsage.intendedUses[*]
industrySector	natureOfBusiness.industryCodes[*]
listedExchange	listedExchange
monthlyTransactionVolume	expectedAccountUsage.debit.monthlyTransactionVolume expectedAccountUsage.credit.monthlyTransactionVolume
monthlyTransactions	expectedAccountUsage.debit.monthlyTransactions expectedAccountUsage.credit.monthlyTransactions
position	applicant.positions[*].title stakeholders.individual[*].positions[*].title stakeholders.corporate[*].positions[*].title
regulatedTrustType	regulatedTrustType[*] \* Valid only for AU
restrictedCountries	restrictedCountries[*] \* Required for the UK
isoState	addresses.registeredAddress.state addresses.businessAddress.state applicant.address.state stakeholders.individual[*].address.state \* Also pass countryCode in the parameter to fetch the state of that respective country.
streetType	addresses.businessAddress.streetType addresses.registeredAddress.streetType \* Valid only for AU, NZ addresses.
totalEmployees	sizeOfBusiness.totalEmployees
trustBeneficiaryClass	applicant.positions[*].trustBeneficiaryClass stakeholders.individual[*].positions[*].trustBeneficiaryClass ****
unregulatedTrustType	unregulatedTrustType[*]

Response

The API response contains an array of code-description pairs that are valid for the given field.

Response field	Usage
code	The valid values that need to be used in the Create Customer v5 request for the given field.
description	A description of the category code which can be shown to the applicant as a dropdown list.