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

Attributes

Attribute	Type	Description
id	string	The unique identifier for a client.
type	string	The type of client. Valid values are: person 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.

Sample Object

{
    "id": "5eaecff4a675310007440c09",
    "entityName": "John Doe",
    "type": "person",
    "email": "[e-mail]",
    "personDetails": {
        "firstName": "John",
        "lastName": "Doe"
    },
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:06:44.756Z"
}

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: male female 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: sole_proprietorship private_limited_company public_limited_company limited_partnership holding_company non_government_organisation statutory_company subsidiary_company unlimited_partnership charitable_incorporated_organisation chartered_company