Fetch Corporate Constants API
The Fetch Corporate Constants API returns acceptable values of various fields that need to be passed via the Onboard Corporate Customer API.
API usage
Some of the enumerated fields have values that change often as they're added or removed, such as intendedUseOfAccount or industrySector. Integrating this API helps you cater to these changes without the need for any further development on your end.
Keeping enumerated values up to date is beneficial to the customers as it improves the application approval rates and reduces the turnaround time for approvals.
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
fieldName to categoryPass 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 Corporate Customer API fieldName |
|---|---|
annualTurnover | riskAssessmentInfo.annualTurnover businessDetails.stakeholders.stakeholderDetails.professionalDetails.capitalContribution |
averageTransactionValue | expectedAccountUsage.debit.averageTransactionValueexpectedAccountUsage.debit.averageTransactionValue |
businessType | businessDetails.businessType businessDetails.stakeholders.businessPartner.businessType |
countryName | businessDetails.addresses.businessAddress.country businessDetails.addresses.registeredAddress.country businessDetails.applicantDetails.address.country businessDetails.applicantDetails.documentDetails.documentIssuanceCountry businessDetails.applicantDetails.taxDetails.country businessDetails.businessPartner.addresses.registeredAddress.country businessDetails.businessPartner.legalDetails.registeredCountry businessDetails.documentDetails.documentIssuanceCountry businessDetails.legalDetails.registeredCountry businessDetails.partnershipDetails.partnerCountry businessDetails.stakeholders.stakeholderDetails.address.country businessDetails.stakeholders.stakeholderDetails.documentDetails.documentIssuanceCountry businessDetails.taxDetails.country riskAssessmentInfo.countryOfOperation riskAssessmentInfo.transactionCountries businessDetails.applicantDetails.nationalityexpectedAccountUsage.debit.topTransactionCountriesexpectedAccountUsage.credit.topTransactionCountries |
countryOfOperation | riskAssessmentInfo.countryOfOperation riskAssessmentInfo.transactionCountries |
documentType | businessDetails.businessType businessDetails.stakeholders.stakeholderDetails.documentType businessDetails.applicantDetails.documentType |
intendedUseOfAccount | riskAssessmentInfo.intendedUseOfAccountexpectedAccountUsage.intendedUses |
industrySector | riskAssessmentInfo.industrySector |
listedExchange | businessDetails.legalDetails.listedExchange |
monthlyTransactionVolume | expectedAccountUsage.debit.monthlyTransactionVolume expectedAccountUsage.credit.monthlyTransactionVolume |
monthlyTransactions | expectedAccountUsage.debit.monthlyTransactions expectedAccountUsage.credit.monthlyTransactions |
position | businessDetails.stakeholders.stakeholderDetails.position businessDetails.stakeholders.businessPartner.businessEntityType businessDetails.applicantDetails.position |
regulatedTrustType | businessDetails.regulatoryDetails.regulatedTrustType * Valid only for AU |
restrictedCountries | riskAssessmentInfo.restrictedCountries * Required for the UK |
state | businessDetails.addresses.registeredAddress.state businessDetails.addresses.businessAddress.state businessDetails.stakeholders.stakeholderDetails.address.state businessDetails.addresses.applicantDetails.address.state * Valid only for US and AU addresses. |
streetType | businessDetails.stakeholders.stakeholderDetails.address.state businessDetails.addresses.applicantDetails.address.state * Valid only for AU addresses. |
totalEmployees | riskAssessmentInfo.totalEmployees |
trustBeneficiaryClass | businessDetails.stakeholders.stakeholderDetails.professionalDetails.trustBeneficiaryClass |
unregulatedTrustType | businessDetails.regulatoryDetails.unregulatedTrustType * Not applicable for HK |
votingRights | businessDetails.stakeholders.stakeholderDetails.professionalDetails.votingRights |
rfiTemplates | This can be used to find the templateId to template name mapping for RFI templates of different regions. |
Response
The API response contains an array of code-description pairs that are valid for the given field.
| Response field | Usage |
|---|---|
code | This object contains the valid values that need to be used in the Onboard Corporate Customer API for the given field. |
description | This object contains a description of the category code which can be shown to the applicant as a dropdown list. |
Updated 25 days ago