sections → items. A single-select item uses
{ "value": "..." }; a multi-select uses { "values": [ ... ] }. Country items
take ISO 3166-1 alpha-3 codes.
Shape
{
"questionnaire": {
"sections": {
"profileDetails": {
"items": {
"occupation": { "value": "15-1132" },
"annualSalary": { "value": "50000_100000" }
}
}
}
}
}
A value outside the lists below returns
400 —
profileDetails.occupation must be one of the allowed options (got 'X'). The
whole payload is rejected and nothing is created.Individual questionnaire
Items marked required if are only needed when their trigger question has the stated value.| Item | Type | Required | Values |
|---|---|---|---|
profileDetails.occupation | single | Yes | Occupation |
profileDetails.annualSalary | single | Yes | Annual salary |
profileDetails.accountPurpose | single | Yes | Account purpose |
profileDetails.expectedMonthlyVolume | single | Yes | Expected monthly volume |
birthNationalityTaxI.countryOfBirth | country | Yes | ISO alpha-3 |
birthNationalityTaxI.cityOfBirth | text | Yes | free text |
birthNationalityTaxI.nationalities | country[] | Yes | array of ISO alpha-3, in values |
birthNationalityTaxI.taxRegistrationsOuts | single | Yes | yes / no |
birthNationalityTaxI.foreignTaxRegistrati | country[] | required if taxRegistrationsOuts = yes | array of ISO alpha-3 |
birthNationalityTaxI.foreignTaxIdentifica | text | required if taxRegistrationsOuts = yes | free text |
Occupation
All 50 codes.| Code | Meaning |
|---|---|
11-1011 | Chief Executives |
11-1021 | General and Operations Managers |
11-2021 | Marketing Managers |
11-3031 | Financial Managers |
11-3121 | Human Resources Managers |
13-2011 | Accountants and Auditors |
13-1111 | Management Analysts |
13-1161 | Market Research Analysts and Marketing Specialists |
15-1121 | Computer Systems Analysts |
15-1131 | Computer Programmers |
15-1132 | Software Developers, Applications |
15-1134 | Web Developers |
15-1122 | Information Security Analysts |
17-2051 | Civil Engineers |
17-2141 | Mechanical Engineers |
23-1011 | Lawyers |
23-2011 | Paralegals and Legal Assistants |
25-2021 | Elementary School Teachers, Except Special Education |
25-2031 | Secondary School Teachers, Except Special and Career/Technical Education |
27-1024 | Graphic Designers |
27-3041 | Editors |
29-1141 | Registered Nurses |
29-1051 | Pharmacists |
29-1069 | Physicians and Surgeons, All Other |
11-9111 | Medical and Health Services Managers |
31-1011 | Home Health Aides |
33-3051 | Police and Sheriff’s Patrol Officers |
33-9032 | Security Guards |
35-1011 | Chefs and Head Cooks |
35-2014 | Cooks, Restaurant |
41-2031 | Retail Salespersons |
43-4051 | Customer Service Representatives |
43-4171 | Receptionists and Information Clerks |
43-3031 | Bookkeeping, Accounting, and Auditing Clerks |
43-9061 | Office Clerks, General |
47-2031 | Carpenters |
47-2111 | Electricians |
47-2152 | Plumbers, Pipefitters, and Steamfitters |
49-3023 | Automotive Service Technicians and Mechanics |
49-9071 | Maintenance and Repair Workers, General |
51-4121 | Welders, Cutters, Solderers, and Brazers |
51-4041 | Machinists |
51-1011 | First-Line Supervisors of Production and Operating Workers |
51-9111 | Packaging and Filling Machine Operators and Tenders |
53-3032 | Heavy and Tractor-Trailer Truck Drivers |
53-3033 | Light Truck or Delivery Services Drivers |
53-7051 | Industrial Truck and Tractor Operators |
41-2011 | Cashiers |
11-3011 | Administrative Services Managers |
13-1071 | Human Resources Specialists |
Annual salary
| Code | Meaning |
|---|---|
0_12000 | 0−12,000 |
12000_25000 | 12,000−25,000 |
25000_50000 | 25,000−50,000 |
50000_100000 | 50,000−100,000 |
100000_plus | $100,000 or more |
Account purpose
| Code | Meaning |
|---|---|
charitable_donations | Charitable Donations |
ecommerce_retail_payments | E-Commerce Retail Payments |
investment_purposes | Investment Purposes |
payments_to_friends_or_family_abroad | Payments to friends or family abroad |
payroll | Payroll |
personal_or_living_expenses | Personal or Living Expenses |
purchase_goods_and_services | Purchase Goods & Services |
Expected monthly volume
| Code | Meaning |
|---|---|
0_10000 | 0−10,000 |
10000_25000 | 10,000−25,000 |
25000_50000 | 25,000−50,000 |
50000_100000 | 50,000−100,000 |
100000_plus | $100,000 or more |
Custom fields
Sent ascustomFields, alongside the questionnaire rather than inside it.
| Key | Required | Notes |
|---|---|---|
nationalIdNumber | Yes | National ID card number. |
whatsappNumber | Yes | Include the country code, e.g. +971…. |
telegramId | No | Telegram handle, e.g. @janedoe. |
400 unknown custom field 'foo'.
Business questionnaire
| Item | Type | Required | Values |
|---|---|---|---|
businessIndustry.businessIndustry | single | Yes | Business industry |
businessIndustry.businessDescription | text | Yes | free text |
businessIndustry.pleaseSpecifyWhether | single | Yes | yes / no |
businessIndustry.isYourEntityADaoDece | single | Yes | yes / no |
businessIndustry.isYourEntitysOperati | single | Yes | yes / no |
businessIndustry.ifYesPleaseProvideTh | text | required if isYourEntitysOperati = yes | free text |
businessIndustry.isYourCompanyALicens | single | Yes | Yes / No |
businessIndustry.ifYesPleasePro_gd5nk | file | required if isYourCompanyALicens = Yes | cannot be sent through this JSON API |
businessIndustry.isYourCompanyRegiste | single | Yes | Yes / No |
businessIndustry.isYourCompanyR_l3j1n | single | required if isYourCompanyRegiste = Yes | UAE Mainland / UAE Free Zone |
sourceOfFunds.primarySourceOfFunds | single | Yes | Source of funds |
sourceOfFunds.pleaseProvideADetail | text | Yes | free text |
sourceOfFunds.estimatedAnnualReven | single | Yes | Estimated annual revenue |
sourceOfFunds.willYouBeTransmittin | single | Yes | yes / not_applicable |
sourceOfFunds.complianceScreeningE | text | required if willYouBeTransmittin = yes | free text |
businessActivity.doesYourBusinessOper | single | Yes | yes / no |
businessActivity.pleaseSelectAllActiv | multi | Yes | Business activities |
expectedAccountUsage.primaryAccountPurpos | single | Yes | Primary account purpose |
expectedAccountUsage.ifOtherPleaseSpecify | text | required if primaryAccountPurpos = other | free text |
expectedAccountUsage.enterTheAmountYouExp | text | Yes | free text amount |
ifYesPleasePro_gd5nk is a file item. It cannot be supplied through this
JSON API — a licensed company needs to provide that document another way.Business industry
| Code | Meaning |
|---|---|
541511 | Blockchain/Software Company (541511) |
523210 | Broker Dealer/OTC Dealer/Commodities Firm (523210) |
813410 | Charity/NGO/Non-Profit (813410) |
524126 | Insurance Company (524126) |
523940 | Investment Advisory/Asset Management (523940) |
522220 | Lease or Finance Company (522220) |
523991 | Non-Bank Custodians (including Crypto) (523991) |
522320 | Third-Party Payment Processor (522320) |
425120 | Wholesale Trade Agents and Brokers (425120) |
541990 | Professional Services (541990) |
541611 | Management Accounting and Consultancy (541611) |
336320 | EV Company (336320) |
Source of funds
| Code | Meaning |
|---|---|
business_loans | Business Loan |
grants | Grants |
inter_company_funds | Inter Company Funds |
investment_proceeds | Investment Proceeds |
legal_settlement | Legal Settlement |
owners_capital | Owner’s Capital |
pension_retirement | Pension/Retirement |
sale_of_assets | Sale of Assets |
sales_of_goods_and_services | Sale of Goods and Services |
third_party_funds | Third Party Funds |
treasury_reserves | Treasury Reserves |
tax_refund | Tax Refund |
Estimated annual revenue
| Code | Meaning |
|---|---|
0_99999 | 0−99,999 |
100000_999999 | 100,000−999,999 |
1000000_9999999 | 1Million−9 Million |
10000000_49999999 | 10Million−49 Million |
50000000_249999999 | 50Million−249 Million |
250000000_plus | > $250 Million |
Business activities
Multi-select — send any number of these invalues.
| Code | Meaning |
|---|---|
money_services_i_e_check_cashing_gift_cards_atms_remittances | Money Services (i.e., check cashing, gift cards, ATMs, remittances) |
lending_banking | Lending / Banking |
operate_foreign_exchange_virtual_currencies_brokerage_otc | Operate Foreign Exchange / Virtual Currencies Brokerage / OTC |
hold_client_funds_i_e_escrow | Hold Client Funds (i.e., escrow) |
investment_services | Investment Services |
safe_deposit_box_rentals | Safe Deposit Box Rentals |
marijuana_or_related_services | Marijuana or Related Services |
third_party_payment_processing | Third-Party Payment Processing |
adult_entertainment | Adult Entertainment |
weapons_firearms_and_explosives | Weapons, Firearms, and Explosives |
gambling | Gambling |
nicotine_tobacco_or_related_services | Nicotine, Tobacco or Related Services |
pharmaceuticals | Pharmaceuticals |
precious_metals_precious_stones_jewelry | Precious Metals, Precious Stones, Jewelry |
none_of_the_above | None of the above |
Primary account purpose
| Code | Meaning |
|---|---|
charitable_donations | Charitable Donations |
ecommerce_retail_payments | E-Commerce Retail Payments |
investment_purposes | Investment Purposes |
payments_to_friends_or_family_abroad | Payments to friends or family abroad |
payroll | Payroll |
personal_or_living_expenses | Personal or Living Expenses |
protect_wealth | Protect Wealth |
purchase_goods_and_services | Purchase Goods & Services |
receive_payments_for_goods_and_services | Receive Payments for Goods & Services |
tax_optimization | Tax Optimization |
third_party_money_transmission | Third Party Money Transmission |
treasury_management | Treasury Management |
other | Other |