GET
/
api
/
v1
/
clients
Search & List Customers
curl --request GET \
  --url http://localhost:8080/api/v1/clients
[
  {
    "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>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_blacklisted": true,
    "last_name": "<string>",
    "nationality": "<string>",
    "organization_id": 123,
    "postcode": "<string>",
    "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

​
limit
integer<int64> | null
​
offset
integer<int64> | null
​
organization_id
integer<int32> | null
​
kyc_status
null | enum<string>
Available options:
NOT_STARTED,
CREATED,
PROCESSING,
ABORTED,
PENDING_REVIEW,
VALIDATED,
DECLINED
​
risk_level
null | enum<string>

Risk Level - Customer risk assessment

Available options:
Low,
Medium,
High
​
is_blacklisted
boolean | null
​
blocked
boolean | null

Response

List of clients

​
address
string
required
​
birth_country
string
required
​
blocked
boolean
required
​
city
string
required
​
country_code
string
required
​
country_of_tax_residence
string
required
​
created_at
string<date-time>
required
​
date_of_birth
string<date>
required
​
email
string
required
​
first_name
string
required
​
gender
enum<string>
required
Available options:
male,
female
​
id
string<uuid>
required
​
is_blacklisted
boolean
required
​
kyc_level
enum<string>
required

KYC Level - Defines the level of verification required

Available options:
FULL_KYC,
DOC_ONLY,
NOT_REQUIRED
​
kyc_status
enum<string>
required
Available options:
NOT_STARTED,
CREATED,
PROCESSING,
ABORTED,
PENDING_REVIEW,
VALIDATED,
DECLINED
​
last_name
string
required
​
nationality
string
required
​
organization_id
integer<int32>
required
​
postcode
string
required
​
risk_level
enum<string>
required

Risk Level - Customer risk assessment

Available options:
Low,
Medium,
High
​
updated_at
string<date-time>
required
​
blacklisted_comment
string | null
​
external_client_code
string | null
​
kyc_note
string | null
​
middle_name
string | null
​
mobile_phone_number
string | null
​
planned_expenditure
string | null
​
planned_income
string | null
​
second_email
string | null
​
second_mobile_phone_number
string | null
​
state_province
string | null