Create a client

Create a client

POST https://api.complycube.com/v1/clients

Creates a new client.

Headers

Name	Type	Description
Content-Type	string	The content-type must always be set to application/json.
Authorization	string	The API live or test key

Request Body

Name	Type	Description
type	string	The type of client. Valid values are: 1. person 2. company
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 the client was registered with you. This is relevant for users that migrate existing customers. The format is YYYY-MM-DD.
personDetails	object	Primary details for a client of type person. This is required when the type is person.
companyDetails	object	Primary details for a client of type company. This is required when the type is company.

200 Client successfully created.

{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "[e-mail]",
    "mobile": "[phone]",
    "telephone": "[phone]",
    "joinedDate": "2020-01-01",
    "personDetails": {
        "firstName": "John",
        "lastName": "Doe",
        "dob": "1990-01-01",
        "nationality": "GB"
    },
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:24:29.146Z"
}

400 An example of a Bad Request, when an invalid client type is provided.

{
    "type": "invalid_request",
    "message": "'type' should be equal to one of the allowed values: person,company",
    "param": "type"
}

The personDetails object

Attribute	Type	Optionality	Description
firstName	string	Required	The client's first name.
middleName	string	Optional	The client's middle name.
lastName	string	Required	The client's last name.
dob	string	Optional	The client's date of birth. The format is YYYY-MM-DD.
gender	string	Optional	The client's gender. Valid values include: male female other
nationality	string	Optional	The client's nationality. This will be the two-letter country ISO code.
birthCountry	string	Optional	The client's birth country. This will be the two-letter country ISO code.

The companyDetails object

Attribute	Type	Optionality	Description
name	string	Required	The client's name.
website	string	Optional	The client's website.
registrationNumber	string	Optional	The client's registration or incorporation number.
incorporationCountry	string	Optional	The client's incorporation country. This will be the two-letter country ISO code.
incorporationType	string	Optional	The client'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

Example request

cURL

curl -X POST https://api.complycube.com/v1/clients \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"type": "person",
						"email": "[e-mail]",
						"mobile": "[phone]",
						"telephone": "[phone]",
						"joinedDate": "2020-01-01",
						"personDetails":{
							"firstName": "John",
							"lastName" :"Doe",
							"dob": "1990-01-01",
							"nationality": "GB"
						}
        }'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.client.create({
  type: "person",
  email: "[e-mail]",
  mobile: "[phone]",
  telephone: "[phone]",
  joinedDate: "2020-01-01",
  personDetails: {
    firstName: "John",
    lastName: "Doe",
    dob: "1990-01-01",
    nationality: "GB"
  }
});

Python

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

new_client = {
    'type':'person',
    'email':'[e-mail]',
    'personDetails': {
        'firstName':'John',
        'lastName':'Smith'
    }
}

client = cc_api.clients.create(**new_client)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$result = $ccapi->clients()->create(['type' => 'person',
                                     'email' => '[e-mail]',
                                     'personDetails' => ['firstName' => 'John',
                                                         'lastName' => 'Doe']]);