Search & List Customers
curl --request GET \
--url http://localhost:8080/api/v1/clientsimport requests
url = "http://localhost:8080/api/v1/clients"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/clients', 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",
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"
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")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
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
Search & List Customers
List clients with optional filters (organization, KYC status, risk level, blacklist, blocked) and pagination (max 100). Sorted newest first.
GET
/
api
/
v1
/
clients
Search & List Customers
curl --request GET \
--url http://localhost:8080/api/v1/clientsimport requests
url = "http://localhost:8080/api/v1/clients"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/clients', 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",
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"
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")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/clients")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
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>"
}
]Query Parameters
Available options:
NOT_STARTED, CREATED, PROCESSING, ABORTED, PENDING_REVIEW, VALIDATED, DECLINED Risk Level - Customer risk assessment
Available options:
Low, Medium, High Response
List of clients
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