API Reference
Search…
Filtering clients
Below is a list of attributes available for filtering clients.
Attribute
Type
type
string
email
string
joinedDate
string
mobile
string
telephone
string
personDetails.firstName
string
personDetails.middleName
string
personDetails.lastName
string
personDetails.dob
string
personDetails.gender
string
personDetails.nationality
string
personDetails.birthCountry
string
companyDetails.name
string
companyDetails.website
string
companyDetails.registrationNumber
string
companyDetails.incorporationType
string
companyDetails.incorporationCountry
string

Example - Get all clients for one type

In the example below, we will request to get all clients that are of type company.
cURL
Python
PHP
.NET
1
curl -X GET https://api.complycube.com/v1/clients?type=company \
2
-H 'Authorization: <YOUR_API_KEY>'
Copied!
1
from complycube import ComplyCubeClient
2
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')
3
4
filter = { 'type':'company' }
5
6
companies = cc_api.clients.list(filter)
Copied!
1
use ComplyCube\ComplyCubeClient;
2
3
$ccapi = new ComplyCubeClient('<YOUR API KEY>');
4
5
$companies = $ccapi->clients()->list(['type' => 'company']);
Copied!
1
using ComplyCube.Net;
2
using ComplyCube.Net.Resources.Clients;
3
4
var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));
5
6
var filter = new ClientRequest { type = "company" };
7
8
var companies = await clientApi.ListAsync(filter);
Copied!