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
metadata.{yourCustomKey}	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

curl -X GET https://api.complycube.com/v1/clients?type=company \
     -H 'Authorization: <YOUR_API_KEY>'

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

filter = { 'type':'company' }

companies = cc_api.clients.list(filter)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');

$companies = $ccapi->clients()->list(['type' => 'company']);

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var filter = new ClientRequest { type = "company" };

var companies = await clientApi.ListAsync(filter);