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.
Attribute | Type | Description |
id | string | The unique identifier for a client. |
type | string | The type of client. Valid values are:
|
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 | |
companyDetails | object | |
metadata | object | Set of key-value pairs that you can associate with the client object. This is useful for storing additional information about the client in a structured format. You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long. |
createdAt | string | The date and time when the client was created. |
updatedAt | string | The date and time when the client was updated. |
Attribute | Type | Description |
firstName | string | The client's first name. (Required) |
middleName | string | The client's middle name. (Optional) |
lastName | string | The client's last name. (Required) |
dob | string | The client's date of birth. The format is YYYY-MM-DD . (Optional) |
gender | string | The client's gender. Valid values include:
(Optional) |
nationality | string | |
birthCountry | string | |
ssn | string | The client's SSN (Social Security Number). This is for US clients. (Optional) |
socialInsuranceNumber | string | The client's Social Insurance Number. (Optional) |
nationalIdentityNumber | string | The client's National Identity Number. (Optional) |
taxIdentificationNumber | string | The client's Tax Identification Number (TIN). (Optional) |
Attribute | Type | Description |
name | string | The client's name. (Required) |
website | string | The client's website. (Optional) |
registrationNumber | string | The client's registration or incorporation number. (Optional) |
incorporationCountry | string | |
incorporationType | string | The client's incorporation type. Valid values include:
(Optional) |
Last modified 1mo ago