GET
/
api
/
v1
/
clients
/
{client_id}
/
onboarding
/
details
Get Customer Onboarding Details
curl --request GET \
  --url http://localhost:8080/api/v1/clients/{client_id}/onboarding/details
{
  "account_purposes": [],
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_us_person": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "funds_origin_country_id": 123,
  "kyc_application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kyc_link": "<string>",
  "other_occupation": "<string>",
  "other_source_of_funds": "<string>",
  "tax_identification_number": "<string>"
}

Path Parameters

​
client_id
string<uuid>
required

Client UUID

Response

Onboarding details retrieved successfully

​
account_purposes
enum<string>[]
required

Account Purpose - What the account will be used for Note: Stored as JSONB array in database, not a custom SQL type

Available options:
PAY_BILLS,
MONEY_TO_FROM_FAMILY,
DIVIDENDS,
SAVINGS,
PERSONAL_BUSINESS_PURPOSES,
PENSION,
CRYPTO,
SALARY,
LOTTERY_GAMING,
RECONCILIATION,
VIRTUAL_ACCOUNT,
CURRENCY_EXCHANGE,
OTHER
​
created_at
string<date-time>
required
​
expected_monthly_incoming_volume
enum<string>
required

Monthly Volume Range - Expected transaction volumes

Available options:
LESS_THAN1000,
BETWEEN1001_AND5000,
BETWEEN5001_AND10000,
BETWEEN10001_AND15000,
BETWEEN15001_AND30000,
BETWEEN30001_AND60000,
MORE_THAN60001
​
expected_monthly_outgoing_volume
enum<string>
required

Monthly Volume Range - Expected transaction volumes

Available options:
LESS_THAN1000,
BETWEEN1001_AND5000,
BETWEEN5001_AND10000,
BETWEEN10001_AND15000,
BETWEEN15001_AND30000,
BETWEEN30001_AND60000,
MORE_THAN60001
​
id
string<uuid>
required
​
is_us_person
boolean
required
​
occupation
enum<string>
required

Occupation - Client's work or business

Available options:
BUSINESS_OWNER,
CLERGY,
CRAFTSMAN,
ENGINEER,
EXECUTIVE,
FARMER,
FREELANCE,
LIBERAL_PROFESSION,
POLITICIAN,
PROFESSOR,
PUBLIC_SERVANT,
RETIRED,
SHOPKEEPER,
STUDENT,
UNEMPLOYED,
WORKER,
OTHER
​
occupation_sector
enum<string>
required

Occupation Sector - Industry/sector of work

Available options:
ACCOUNTING_AUDIT,
E_MONEY_SERVICES,
CURRENCY_EXCHANGE,
TRADES_ON_OTC_MARKET,
PRECIOUS_METALS_OR_STONES,
PAWNSHOPS,
CROSS_BORDER_CASH_OR_PRECIOUS_MATERIALS,
MINING_EXTRACTIVE_INDUSTRIES,
ENERGY,
TRADE_IN_PETROL_PRODUCTS,
TRADE_IN_MEDICINES,
REAL_ESTATE,
CONSTRUCTION_REPAIR,
CONSULTANCY_LEGAL,
FREELANCE,
NON_PROFIT_LEGAL_ENTITIES,
CRYPTOCURRENCIES,
GAMING,
GAMBLING,
EU_FUNDS_UTILIZATION,
ADULT,
HIGH_VALUE_ASSET_DEALER,
BANKING_LENDING,
INSURANCE_SECURITY,
TRANSPORTATION_AND_LOGISTICS,
MANUFACTURING,
UTILITIES_AND_INFRASTRUCTURE,
TRADE_IN_FOOD_PRODUCT,
WHOLESALE,
REPAIR_OF_MOTOR_VEHICLES,
SOCIAL_WORK_ACTIVITIES,
AUTO_AVIATION,
COURIER_POST_SERVICES,
AGRICULTURE_FORESTRY_AND_FISHING,
OTHER_TRADE_AND_SALES,
TRAVEL_TOURISM,
INFORMATION_AND_COMMUNICATION,
PR_MARKETING,
EDUCATION,
INFORMATIONAL_TECHNOLOGIES,
PUBLIC_AND_DEFENCE_SECTOR,
HEALTH_CARE_MEDICAL_SERVICES,
ART_ENTERTAINMENT_SPORT,
ADMINISTRATIVE_OFFICE_BUSINESS_ACTIVITIES,
HOSPITALITY_AND_LEISURE,
SCIENTIFIC_AND_TECHNICAL_ACTIVITIES,
OTHER
​
source_of_funds
enum<string>
required

Source of Funds - Where the client's money comes from

Available options:
COMPENSATION_PAYOUT,
COMPANY_PROFITS,
COMPANY_SALE,
DIVIDEND_PAYMENTS,
DIVORCE_SETTLEMENT,
FIXED_DEPOSITS,
GIFT,
INHERITANCE,
INSURANCE_PAYOUT,
LOAN,
LOTTERY_OR_GAMBLING_WIN,
RETIREMENT_INCOME,
SALE_OF_INVESTMENT,
SALE_OF_PROPERTY,
SAVINGS_FROM_SALARY,
OTHER
​
updated_at
string<date-time>
required
​
funds_origin_country_id
integer<int32> | null
​
kyc_application_id
string<uuid> | null
​
kyc_link
string | null
​
other_occupation
string | null
​
other_source_of_funds
string | null
​
tax_identification_number
string | null