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 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 Corporate Customer API fieldName |
---|---|
annualTurnover | riskAssessmentInfo.annualTurnover |
averageTransactionValue | expectedAccountUsage.debit.averageTransactionValue expectedAccountUsage.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.nationality expectedAccountUsage.debit.topTransactionCountries expectedAccountUsage.credit.topTransactionCountries |
countryOfOperation | riskAssessmentInfo.countryOfOperation riskAssessmentInfo.transactionCountries |
documentType | businessDetails.businessType businessDetails.stakeholders.stakeholderDetails.documentType businessDetails.applicantDetails.documentType |
intendedUseOfAccount | riskAssessmentInfo.intendedUseOfAccount expectedAccountUsage.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 |
unregulatedTrustType | businessDetails.regulatoryDetails.unregulatedTrustType * Not applicable for HK |
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 description of category code which can be shown to the applicant as a dropdown list. |
Deprecated values
Some of the previously supported values in the following fields are deprecated to support a new risk model and will not be available from September 2, 2023. Update the acceptable values using Fetch Corporate Constants API. After updated, reach out to Nium Support for migration to the new risk model.
annualTurnover
annualTurnover
These values are found in riskAssessmentInfo > annualTurnover
AU
Enum value | Description | Regulatory region |
---|---|---|
AU001 | Less than AUD 10,000 | AU __ __ __ __ |
AU002 | AUD 10,000 to AUD 25,000 | AU __ __ __ __ |
AU003 | AUD 25,000 to AUD 50,000 | AU __ __ __ __ |
AU004 | AUD 50,000 to AUD 100,000 | AU __ __ __ __ |
AU005 | AUD 100,000 to AUD 250,000 | AU __ __ __ __ |
AU006 | AUD 250,000 to AUD 500,000 | AU __ __ __ __ |
AU007 | AUD 500,000+ | AU __ __ __ __ |
EU
Enum value | Description | Regulatory region |
---|---|---|
EU001 | Less than EUR 10,000 | __ EU __ __ __ |
EU002 | EUR 10,000 to EUR 25,000 | __ EU __ __ __ |
EU003 | EUR 25,000 to EUR 50,000 | __ EU __ __ __ |
EU004 | EUR 50,000 to EUR 100,000 | __ EU __ __ __ |
EU005 | EUR 100,000 to EUR 250,000 | __ EU __ __ __ |
EU006 | EUR 250,000 to EUR 500,000 | __ EU __ __ __ |
EU007 | EUR 500,000+ | __ EU __ __ __ |
SG
Enum value | Description | Regulatory region |
---|---|---|
SG001 | Less than SGD 10,000 | __ __ SG __ __ |
SG002 | SGD 10,000 to SGD 25,000 | __ __ SG __ __ |
SG003 | SGD 25,000 to SGD 50,000 | __ __ SG __ __ |
SG004 | SGD 50,000 to SGD 100,000 | __ __ SG __ __ |
SG005 | SGD 100,000 to SGD 250,000 | __ __ SG __ __ |
SG006 | SGD 250,000 to SGD 500,000 | __ __ SG __ __ |
SG007 | SGD 500,000+ | __ __ SG __ __ |
UK (GB)
Enum value | Description | Regulatory region |
---|---|---|
GB001 | Less than GBP 10,000 | __ __ __ UK __ |
GB002 | GBP 10,000 to GBP 25,000 | __ __ __ UK __ |
GB003 | GBP 25,000 to GBP 50,000 | __ __ __ UK __ |
GB004 | GBP 50,000 to GBP 100,000 | __ __ __ UK __ |
GB005 | GBP 100,000 to GBP 250,000 | __ __ __ UK __ |
GB006 | GBP 250,000 to GBP 500,000 | __ __ __ UK __ |
GB007 | GBP 500,000+ | __ __ __ UK __ |
US
Enum value | Description | Regulatory region |
---|---|---|
US001 | Less than USD 10,000 | __ __ __ __ US |
US002 | USD 10,000 to USD 25,000 | __ __ __ __ US |
US003 | USD 25,000 to USD 50,000 | __ __ __ __ US |
US004 | USD 50,000 to USD 100,000 | __ __ __ __ US |
US005 | USD 100,000 to USD 250,000 | __ __ __ __ US |
US006 | USD 250,000 to USD 500,000 | __ __ __ __ US |
US007 | USD 500,000+ | __ __ __ __ US |
industrySector
industrySector
These values can be found in riskAssessmentInfo > industrySector
Enum Value | Description | Regulatory Region |
---|---|---|
IS057 | Accountancy firm | AU EU SG UK US |
IS001 | Aerospace, defense | AU EU SG UK US |
IS002 | Agricultural services and products | AU EU SG UK US |
IS003 | Agriculture | AU EU SG UK US |
IS004 | Banks, building societies, credit unions | AU EU SG UK US |
IS005 | Beverage providers, suppliers of alcohol, spirits | AU EU SG UK US |
IS006 | Beverage providers, suppliers of non-alcoholic drinks. | AU EU SG UK US |
IS007 | Charitable organization | AU EU SG UK US |
IS008 | Chemicals sales, distribution | AU EU SG UK US |
IS009 | Chemical and related manufacturing | AU EU SG UK US |
IS010 | Computer software | AU EU SG UK US |
IS011 | Construction | AU EU SG UK US |
IS012 | Consultancy | AU EU SG UK US |
IS013 | Designers, engineers | AU EU SG UK US |
IS014 | Doctors and other health care professionals | AU EU SG UK US |
IS015 | Drug manufacturing, supplies, including legal cannabis, and marijuana trade | AU EU SG UK US |
IS016 | Education providers | AU EU SG UK US |
IS017 | Entertainment industry | AU EU SG UK US |
IS018 | Farming | AU EU SG UK US |
IS019 | Financial services provider, adviser, mortgage broker, loan consultant, debt recovery consultant, pension, etc. | AU EU SG UK US |
IS020 | Food suppliers | AU EU SG UK US |
IS021 | Freelancer | AU EU SG UK US |
IS022 | Gaming houses, casinos | AU EU SG UK US |
IS023 | Government organization for the public sector | AU EU SG UK US |
IS024 | Health care services | AU EU SG UK US |
IS025 | High-value goods, jewelry, gold, commodities | AU EU SG UK US |
IS026 | Insurance providers | AU EU SG UK US |
IS027 | Legal services, lawyers, external counsels, etc. | AU EU SG UK US |
IS028 | Logistics firms, trucks, transportation, freight | AU EU SG UK US |
IS029 | Manufacturing, auto, clothing, electronics, food products, furniture | AU EU SG UK US |
IS030 | Media, marketing | AU EU SG UK US |
IS031 | Migration agent | AU EU SG UK US |
IS032 | Miscellaneous | AU EU SG UK US |
IS033 | Money Service Business (MSB), remittance providers | AU EU SG UK US |
IS034 | Music industry, music production, suppliers, recording | AU EU SG UK US |
IS035 | Nonprofit organizations, government-incentivized entities | AU EU SG UK US |
IS036 | Online gaming developers, providers | AU EU SG UK US |
IS037 | Online shopping providers, suppliers | AU EU SG UK US |
IS038 | Online suppliers of adult content | AU EU SG UK US |
IS039 | Payment platform providers | AU EU SG UK US |
IS040 | Payrolls provider and payroll solution providers | AU EU SG UK US |
IS041 | Pharmaceutical, health products and supplies | AU EU SG UK US |
IS042 | Power, energy providers | AU EU SG UK US |
IS043 | Real estate, property providers | AU EU SG UK US |
IS044 | Recreation, live entertainment | AU EU SG UK US |
IS045 | Recruiting firms, suppliers, providers | AU EU SG UK US |
IS046 | Religious organizations | AU EU SG UK US |
IS047 | Securities and investment | AU EU SG UK US |
IS048 | Security firms | AU EU SG UK US |
IS049 | Superannuation funds providers | AU EU SG UK US |
IS050 | Technology providers | AU EU SG UK US |
IS051 | Telecommunication providers | AU EU SG UK US |
IS052 | Tobacco suppliers, manufacturers, including e-cigarettes, vapors, etc. | AU EU SG UK US |
IS053 | Travel and tourism suppliers, providers | AU EU SG UK US |
IS054 | Trust funds providers | AU EU SG UK US |
IS055 | Undisclosed | AU EU SG UK US |
IS056 | Universities, colleges | AU EU SG UK US |
intendedUseOfAccount
intendedUseOfAccount
These values can be found in riskAssessmentInfo > intendedUseOfAccount
Enum Value | Description | Regulatory Region |
---|---|---|
IU001 | Receive payments for goods or services sold | AU EU SG UK US |
IU002 | Pay suppliers and vendors | AU EU SG UK US |
IU003 | Pay contractors, payroll employees | AU EU SG UK US |
IU004 | Pay rent, utilities, or taxes | AU EU SG UK US |
IU005 | Intracompany payments or transfers | AU EU SG UK US |
IU006 | Receive loan repayments | AU EU SG UK US |
IU007 | Pay mortgage, bank loan, insurance, or credit card payments | AU EU SG UK US |
IU008 | Pay employee travel and expenses | AU EU SG UK US |
IU009 | Receive or send funds to-and-from clients | AU EU SG UK US |
totalEmployees
totalEmployees
These values are found in riskAssessmentInfo > totalEmployees
Enum Value | Description | Regulatory Region |
---|---|---|
EM001 | Less than or equal 5 | AU EU SG UK US |
EM002 | Between 6 to 24 | AU EU SG UK US |
EM003 | Between 25 to 49 | AU EU SG UK US |
EM004 | Between 50 to 99 | AU EU SG UK US |
EM005 | More than 100 | AU EU SG UK US |
Updated 3 months ago