Get a client

URL

GET https://api.complycube.com/v1/clients/:id

Retrieves an existing client.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Path parameters

Name	Type	Description
id*	string	The ID of the client.

Example request

cURL

curl -X GET https://api.complycube.com/v1/clients/{:clientId} \
     -H 'Authorization: <YOUR_API_KEY>'

Node.js

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

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

const client = await complycube.client.get("CLIENT_ID");

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

client = cc_api.clients.get('CLIENT_ID')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$client = $ccapi->clients()->get('CLIENT_ID');

.NET

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

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

var client = await clientApi.GetAsync("CLIENT_ID");

Example response

Success (200)

{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "[email protected]",
    "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"
}

Resource Not Found (404)

{
    "type": "resource_not_found",
    "message": "Invalid client id '5eb04fcd0f3e360008035eb2'"
}