Clients

Clients are a core resource to all ComplyCube services.

A client represents the person or company you will perform on the various checks. To initiate a check, you must first create a client.

The API allows you to create, retrieve, update, and delete your clients. You can retrieve specific clients as well as a list of all your clients.

The Client object

Attribute

Type

Description

id

string

The unique identifier for a client.

type

string

The type of client. Valid values are:

  1. person

  2. company

entityName

string

The client's full name.

email

string

The client's email address.

mobile

string

The client's mobile number.

telephone

string

The client's telephone number.

externalId

string

A unique identifier that you can associate with the client. For example, this can be the client ID in your system.

joinedDate

string

The date and time when you registered the client. This is relevant for users that migrate existing clients. The format is YYYY-MM-DD.

personDetails

object

Details for a client of type person. Also, see the personDetails object below.

companyDetails

object

Details for a client of type company. Also, see the companyDetails object below.

createdAt

string

The date and time when the client was created.

updatedAt

string

The date and time when the client was updated.

The personDetails object

Attribute

Type

Description

firstName

string

The person's first name.

middleName

string

The person's middle name.

lastName

string

The person's last name.

dob

string

The person's date of birth. The format is YYYY-MM-DD.

gender

string

The person's gender. Valid values include:

  1. male

  2. female

  3. other

nationality

string

The person's nationality. This will be the two-letter country ISO code.

birthCountry

string

The person's birth country. This will be the two-letter country ISO code.

The companyDetails object

Attribute

Type

Description

name

string

The company's name.

website

string

The company's website.

registrationNumber

string

The company's registration or incorporation number.

incorporationCountry

string

The company's incorporation country. This will be the two-letter country ISO code.

incorporationType

string

The company's incorporation type. Valid values include:

  1. sole_proprietorship

  2. private_limited_company

  3. public_limited_company

  4. limited_partnership

  5. holding_company

  6. non_government_organisation

  7. statutory_company

  8. subsidiary_company

  9. unlimited_partnership

  10. charitable_incorporated_organisation

  11. chartered_company

Last updated