Get Customer Onboarding Details
curl --request GET \
--url http://localhost:8080/api/v1/clients/{client_id}/onboarding/detailsimport requests
url = "http://localhost:8080/api/v1/clients/{client_id}/onboarding/details"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/clients/{client_id}/onboarding/details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/clients/{client_id}/onboarding/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/clients/{client_id}/onboarding/details"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/clients/{client_id}/onboarding/details")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients/{client_id}/onboarding/details")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"account_purposes": [
"PAY_BILLS"
],
"created_at": "2023-11-07T05:31:56Z",
"expected_monthly_incoming_volume": "LESS_THAN1000",
"expected_monthly_outgoing_volume": "LESS_THAN1000",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_us_person": true,
"occupation": "BUSINESS_OWNER",
"occupation_sector": "ACCOUNTING_AUDIT",
"source_of_funds": "COMPENSATION_PAYOUT",
"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>"
}Onboarding
Get Customer Onboarding Details
Retrieve a client’s onboarding/KYC details: source of funds, occupation, expected monthly volumes, account purposes, verification status, and current step.
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/detailsimport requests
url = "http://localhost:8080/api/v1/clients/{client_id}/onboarding/details"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/clients/{client_id}/onboarding/details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/clients/{client_id}/onboarding/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/clients/{client_id}/onboarding/details"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/clients/{client_id}/onboarding/details")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients/{client_id}/onboarding/details")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"account_purposes": [
"PAY_BILLS"
],
"created_at": "2023-11-07T05:31:56Z",
"expected_monthly_incoming_volume": "LESS_THAN1000",
"expected_monthly_outgoing_volume": "LESS_THAN1000",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_us_person": true,
"occupation": "BUSINESS_OWNER",
"occupation_sector": "ACCOUNTING_AUDIT",
"source_of_funds": "COMPENSATION_PAYOUT",
"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 UUID
Response
Onboarding details retrieved successfully
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 Monthly Volume Range - Expected transaction volumes
Available options:
LESS_THAN1000, BETWEEN1001_AND5000, BETWEEN5001_AND10000, BETWEEN10001_AND15000, BETWEEN15001_AND30000, BETWEEN30001_AND60000, MORE_THAN60001 Monthly Volume Range - Expected transaction volumes
Available options:
LESS_THAN1000, BETWEEN1001_AND5000, BETWEEN5001_AND10000, BETWEEN10001_AND15000, BETWEEN15001_AND30000, BETWEEN30001_AND60000, MORE_THAN60001 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 - 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 - 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