Register New Individual Customer
curl --request POST \
--url http://localhost:8080/api/v1/clients/person \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>",
"birth_country": "<string>",
"city": "<string>",
"country_code": "<string>",
"country_of_tax_residence": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"nationality": "<string>",
"organization_id": 123,
"postcode": "<string>",
"external_client_code": "<string>",
"middle_name": "<string>",
"mobile_phone_number": "<string>",
"planned_expenditure": "<string>",
"planned_income": "<string>",
"second_email": "<string>",
"second_mobile_phone_number": "<string>",
"state_province": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/clients/person"
payload = {
"address": "<string>",
"birth_country": "<string>",
"city": "<string>",
"country_code": "<string>",
"country_of_tax_residence": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"nationality": "<string>",
"organization_id": 123,
"postcode": "<string>",
"external_client_code": "<string>",
"middle_name": "<string>",
"mobile_phone_number": "<string>",
"planned_expenditure": "<string>",
"planned_income": "<string>",
"second_email": "<string>",
"second_mobile_phone_number": "<string>",
"state_province": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
address: '<string>',
birth_country: '<string>',
city: '<string>',
country_code: '<string>',
country_of_tax_residence: '<string>',
date_of_birth: '2023-12-25',
email: '<string>',
first_name: '<string>',
last_name: '<string>',
nationality: '<string>',
organization_id: 123,
postcode: '<string>',
external_client_code: '<string>',
middle_name: '<string>',
mobile_phone_number: '<string>',
planned_expenditure: '<string>',
planned_income: '<string>',
second_email: '<string>',
second_mobile_phone_number: '<string>',
state_province: '<string>'
})
};
fetch('http://localhost:8080/api/v1/clients/person', 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/person",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'birth_country' => '<string>',
'city' => '<string>',
'country_code' => '<string>',
'country_of_tax_residence' => '<string>',
'date_of_birth' => '2023-12-25',
'email' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'nationality' => '<string>',
'organization_id' => 123,
'postcode' => '<string>',
'external_client_code' => '<string>',
'middle_name' => '<string>',
'mobile_phone_number' => '<string>',
'planned_expenditure' => '<string>',
'planned_income' => '<string>',
'second_email' => '<string>',
'second_mobile_phone_number' => '<string>',
'state_province' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/clients/person"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"birth_country\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"country_of_tax_residence\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"nationality\": \"<string>\",\n \"organization_id\": 123,\n \"postcode\": \"<string>\",\n \"external_client_code\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"mobile_phone_number\": \"<string>\",\n \"planned_expenditure\": \"<string>\",\n \"planned_income\": \"<string>\",\n \"second_email\": \"<string>\",\n \"second_mobile_phone_number\": \"<string>\",\n \"state_province\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/clients/person")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"birth_country\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"country_of_tax_residence\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"nationality\": \"<string>\",\n \"organization_id\": 123,\n \"postcode\": \"<string>\",\n \"external_client_code\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"mobile_phone_number\": \"<string>\",\n \"planned_expenditure\": \"<string>\",\n \"planned_income\": \"<string>\",\n \"second_email\": \"<string>\",\n \"second_mobile_phone_number\": \"<string>\",\n \"state_province\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients/person")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"birth_country\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"country_of_tax_residence\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"nationality\": \"<string>\",\n \"organization_id\": 123,\n \"postcode\": \"<string>\",\n \"external_client_code\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"mobile_phone_number\": \"<string>\",\n \"planned_expenditure\": \"<string>\",\n \"planned_income\": \"<string>\",\n \"second_email\": \"<string>\",\n \"second_mobile_phone_number\": \"<string>\",\n \"state_province\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"address": "<string>",
"birth_country": "<string>",
"blocked": true,
"city": "<string>",
"country_code": "<string>",
"country_of_tax_residence": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"date_of_birth": "2023-12-25",
"email": "<string>",
"first_name": "<string>",
"gender": "male",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_blacklisted": true,
"kyc_level": "FULL_KYC",
"kyc_status": "NOT_STARTED",
"last_name": "<string>",
"nationality": "<string>",
"organization_id": 123,
"postcode": "<string>",
"risk_level": "Low",
"updated_at": "2023-11-07T05:31:56Z",
"blacklisted_comment": "<string>",
"external_client_code": "<string>",
"kyc_note": "<string>",
"middle_name": "<string>",
"mobile_phone_number": "<string>",
"planned_expenditure": "<string>",
"planned_income": "<string>",
"second_email": "<string>",
"second_mobile_phone_number": "<string>",
"state_province": "<string>"
}Client Management
Register New Individual Customer
Onboard an individual customer: creates the client and person profile and starts KYC. Email must be unique, the person must be at least 18, and country codes use ISO 3166-1 alpha-3. Identity (KYC) fields are immutable after creation.
POST
/
api
/
v1
/
clients
/
person
Register New Individual Customer
curl --request POST \
--url http://localhost:8080/api/v1/clients/person \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>",
"birth_country": "<string>",
"city": "<string>",
"country_code": "<string>",
"country_of_tax_residence": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"nationality": "<string>",
"organization_id": 123,
"postcode": "<string>",
"external_client_code": "<string>",
"middle_name": "<string>",
"mobile_phone_number": "<string>",
"planned_expenditure": "<string>",
"planned_income": "<string>",
"second_email": "<string>",
"second_mobile_phone_number": "<string>",
"state_province": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/clients/person"
payload = {
"address": "<string>",
"birth_country": "<string>",
"city": "<string>",
"country_code": "<string>",
"country_of_tax_residence": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"nationality": "<string>",
"organization_id": 123,
"postcode": "<string>",
"external_client_code": "<string>",
"middle_name": "<string>",
"mobile_phone_number": "<string>",
"planned_expenditure": "<string>",
"planned_income": "<string>",
"second_email": "<string>",
"second_mobile_phone_number": "<string>",
"state_province": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
address: '<string>',
birth_country: '<string>',
city: '<string>',
country_code: '<string>',
country_of_tax_residence: '<string>',
date_of_birth: '2023-12-25',
email: '<string>',
first_name: '<string>',
last_name: '<string>',
nationality: '<string>',
organization_id: 123,
postcode: '<string>',
external_client_code: '<string>',
middle_name: '<string>',
mobile_phone_number: '<string>',
planned_expenditure: '<string>',
planned_income: '<string>',
second_email: '<string>',
second_mobile_phone_number: '<string>',
state_province: '<string>'
})
};
fetch('http://localhost:8080/api/v1/clients/person', 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/person",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'birth_country' => '<string>',
'city' => '<string>',
'country_code' => '<string>',
'country_of_tax_residence' => '<string>',
'date_of_birth' => '2023-12-25',
'email' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'nationality' => '<string>',
'organization_id' => 123,
'postcode' => '<string>',
'external_client_code' => '<string>',
'middle_name' => '<string>',
'mobile_phone_number' => '<string>',
'planned_expenditure' => '<string>',
'planned_income' => '<string>',
'second_email' => '<string>',
'second_mobile_phone_number' => '<string>',
'state_province' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/clients/person"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"birth_country\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"country_of_tax_residence\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"nationality\": \"<string>\",\n \"organization_id\": 123,\n \"postcode\": \"<string>\",\n \"external_client_code\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"mobile_phone_number\": \"<string>\",\n \"planned_expenditure\": \"<string>\",\n \"planned_income\": \"<string>\",\n \"second_email\": \"<string>\",\n \"second_mobile_phone_number\": \"<string>\",\n \"state_province\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/clients/person")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"birth_country\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"country_of_tax_residence\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"nationality\": \"<string>\",\n \"organization_id\": 123,\n \"postcode\": \"<string>\",\n \"external_client_code\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"mobile_phone_number\": \"<string>\",\n \"planned_expenditure\": \"<string>\",\n \"planned_income\": \"<string>\",\n \"second_email\": \"<string>\",\n \"second_mobile_phone_number\": \"<string>\",\n \"state_province\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients/person")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"birth_country\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"country_of_tax_residence\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"nationality\": \"<string>\",\n \"organization_id\": 123,\n \"postcode\": \"<string>\",\n \"external_client_code\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"mobile_phone_number\": \"<string>\",\n \"planned_expenditure\": \"<string>\",\n \"planned_income\": \"<string>\",\n \"second_email\": \"<string>\",\n \"second_mobile_phone_number\": \"<string>\",\n \"state_province\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"address": "<string>",
"birth_country": "<string>",
"blocked": true,
"city": "<string>",
"country_code": "<string>",
"country_of_tax_residence": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"date_of_birth": "2023-12-25",
"email": "<string>",
"first_name": "<string>",
"gender": "male",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_blacklisted": true,
"kyc_level": "FULL_KYC",
"kyc_status": "NOT_STARTED",
"last_name": "<string>",
"nationality": "<string>",
"organization_id": 123,
"postcode": "<string>",
"risk_level": "Low",
"updated_at": "2023-11-07T05:31:56Z",
"blacklisted_comment": "<string>",
"external_client_code": "<string>",
"kyc_note": "<string>",
"middle_name": "<string>",
"mobile_phone_number": "<string>",
"planned_expenditure": "<string>",
"planned_income": "<string>",
"second_email": "<string>",
"second_mobile_phone_number": "<string>",
"state_province": "<string>"
}Body
application/json
Request to create a new individual (person) client
Available options:
male, female KYC Level - Defines the level of verification required
Available options:
FULL_KYC, DOC_ONLY, NOT_REQUIRED Risk Level - Customer risk assessment
Available options:
Low, Medium, High Response
Client created successfully
ClientWithPerson - Combined view of Client + Person for API responses
Available options:
male, female KYC Level - Defines the level of verification required
Available options:
FULL_KYC, DOC_ONLY, NOT_REQUIRED Available options:
NOT_STARTED, CREATED, PROCESSING, ABORTED, PENDING_REVIEW, VALIDATED, DECLINED Risk Level - Customer risk assessment
Available options:
Low, Medium, High ⌘I