Effectuer une vérification d’identité

Utilisez l’API pour effectuer des vérifications de vérification d’identité et valider les données client pour le KYC.

Vue d'ensemble

Ce guide vous montre comment effectuer une vérification d’identité à l’aide de l’API ComplyCube.

Vous pouvez essayer cette vérification dès maintenant en utilisant notre collection Postman de démonstration. Elle est accessible publiquement et ne nécessite aucun compte.

Étapes d'intégration

Créer un client

La première étape pour créer toute vérification consiste à ajouter un client depuis votre serveur backend. Un client peut représenter soit une personne ou une entreprise.

La réponse contiendra un identifiant (l'ID du client). Il est requis pour l'étape suivante.

Exemple de requête pour créer un client

curl -X POST https://api.complycube.com/v1/clients \
     -H 'Authorization: <YOUR_API_KEY>' \\
     -H 'Content-Type: application/json' \\
     -d '{
          "type": "person",
          "email": "john.doe@example.com",
          "personDetails":{
               "firstName": "John",
               "lastName" :"Doe",
               "dob": "1990-01-01"
          }
        }'

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

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

const client = await complycube.client.create({
  type: "person",
  email: "john.doe@example.com",
  personDetails: {
    firstName: "John",
    lastName: "Doe",
    dob: "1990-01-01"
  }
});

from complycube import ComplyCubeClient

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

new_client = {
    'type':'person',
    'email':'john.doe@example.com',
    'personDetails': {
        'firstName':'John',
        'lastName':'Doe',
        'dob':'1990-01-01'
    }
}

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

use ComplyCube\ComplyCubeClient;

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

$result = $ccapi->clients()->create([
    'type' => 'person',
    'email' => 'john.doe@example.com',
    'personDetails' => [
        'firstName' => 'John',
        'lastName' => 'Doe',
        'dob' => '1990-01-01'
    ]
]);

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

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

var newclient = new ClientRequest {
  type = "person",
    email = "john.doe@example.com",
    personDetails = new PersonDetails {
      firstName = "John",
        lastName = "Doe",
        dob = "1990-01-01"
    }
}

var client = await clientApi.CreateAsync(newclient);

Exemple de réponse

{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "john.doe@example.com",
    "personDetails": {
        "firstName": "John",
        "lastName": "Doe",
        "dob": "1990-01-01"
    },
    "createdAt": "2025-01-04T17:24:29.146Z",
    "updatedAt": "2025-01-04T17:24:29.146Z"
}

Créer une photo en direct

Téléversez une image selfie encodée en BASE64 du client. L’image doit être au format JPG ou PNG et entre 34 Ko et 4 Mo de taille.

Ci-dessous se trouve un exemple d’image selfie encodée en BASE64. Téléchargez-la et copiez son contenu. Ensuite, collez-le dans le data attribut lors de la requête.

La réponse contiendra un id (l’ID de la photo en direct). Il sera requis plus tard.

Exemple de requête pour téléverser la photo en direct

curl -X POST https://api.complycube.com/v1/livePhotos \\
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId":"5eb04fcd0f3e360008035eb1",
          "data": "<BASE64_DATA_CONTENT>"
        }'

var livePhotoRequest = new LivePhotoRequest
                    {
                        clientId = "5eb04fcd0f3e360008035eb1",
                        data= "<BASE64_DATA_CONTENT>"
                    };

var livePhoto = await livePhotoApi.UploadAsync(livePhotoRequest);

Exemple de réponse

{
    "id": "5eb1b5f231778a0008d1c3f6",
    "clientId": "5eb04fcd0f3e360008035eb1",
    "downloadLink": "/livePhotos/5eb1b5f231778a0008d1c3f6/download",
    "contentType": "images/jpg",
    "size": 44896,
    "createdAt": "2025-01-01T14:06:44.756Z",
    "updatedAt": "2025-01-01T14:06:44.756Z"
}

Créer un document

Créez un document en fournissant le ID du client et un type de document (p. ex. passeport, carte d’identité nationale).

La réponse contiendra un identifiant (l’identifiant du document). Il est requis pour l’étape suivante.

Exemple de requête pour créer un document

curl -X POST https://api.complycube.com/v1/documents \
     -H 'Authorization: <YOUR_API_KEY>' \\
     -H 'Content-Type: application/json' \\
     -d '{
          "clientId":"5eb04fcd0f3e360008035eb1",
          "type": "passport",
          "issuingCountry": "GB"
        }'

var docRequest = new DocumentRequest {
  clientId = "5eb04fcd0f3e360008035eb1",
  type = "passport",
  issuingCountry = "GB"
};

var document = await docApi.CreateAsync(docRequest);

Exemple de réponse

{
    "id": "5ebd40714f23960008c81527",
    "type": "passport",
    "issuingCountry": "GB",
    "createdAt": "2025-01-04T17:25:21.116Z",
    "updatedAt": "2025-01-04T17:25:21.116Z"
}

Téléverser le recto de la pièce d’identité

Téléchargez une image encodée en BASE64 du recto du document d’identité. Selon le type de document et le pays émetteur, les deux côtés peuvent être requis.

Les images doivent être au format JPG, PNG, ou PDF et avoir une taille comprise entre 34 Ko et un 4 Mo .

Vous trouverez ci-dessous un exemple de fichier encodé en BASE64. Téléchargez-le, copiez son contenu et collez-le dans le data attribut lors de l'envoi de la requête.

Exemple de requête pour téléverser l’image du recto d’un document

 curl -X POST https://api.complycube.com/v1/documents/5ebd40714f23960008c81527/upload/front \
     -H 'Authorization: <YOUR_API_KEY>' \\
     -H 'Content-Type: application/json' \\
     -d '{
         "fileName": "front-test.jpg",
         "data": "<BASE64_DATA_CONTENT>"
        }'

$up = $ccapi->documents()->upload(
    '5ebd40714f23960008c81527', 
    'front', 
    [
        'fileName' => 'front-test.jpg',
        'data' => '<BASE64_DATA_CONTENT>'
    ]
);

var docFront = new ImageRequest {
  fileName = "front-test.jpg",
  data = "<BASE64_DATA_CONTENT>"
};

var img = await docApi.UploadImageAsync(
    "5eb169302d868c0008828591", 
    "front", 
    docFront
);

Exemple de réponse

{
    "id": "5eb169302d868c0008828591",
    "fileName": "front-test.jpg",
    "documentSide": "front",
    "downloadLink": "/documents/5ebd40714f23960008c81527/images/5eb169302d868c0008828591/download",
    "contentType": "image/jpg",
    "size": 72716,
    "createdAt": "2025-01-04T17:25:21.116Z",
    "updatedAt": "2025-01-04T17:25:21.116Z"
}

Créer une vérification d’identité

Créez une vérification d’identité en spécifiant le ID client, ID de la photo en direct, ID du document, ainsi que le type de vérification.

La réponse contiendra un id (l’ID de vérification). Il est requis pour l’étape suivante.

Exemple de requête pour créer une vérification

curl -X POST https://api.complycube.com/v1/checks \\
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId":"5eb04fcd0f3e360008035eb1",
          "livePhotoId":"5eb1b5f231778a0008d1c3f6",
          "documentId":"5ebd40714f23960008c81527",
          "type": "identity_check"
        }'

const check = await complycube.check.create("5eb04fcd0f3e360008035eb1", {
        livePhotoId: "5eb1b5f231778a0008d1c3f6",
        documentId: "5ebd40714f23960008c81527",
        type: "identity_check"
});

check = cc_api.checks.create('5eb04fcd0f3e360008035eb1', 
                                'identity_check', 
                                livePhotoId='5eb1b5f231778a0008d1c3f6',
                                documentId='5ebd40714f23960008c81527')

$result = $ccapi->checks()->create('5eb04fcd0f3e360008035eb1',
                                   ['type' => 'identity_check',
                                   'livePhotoId' => '5eb1b5f231778a0008d1c3f6',
                                   'documentId' => '5ebd40714f23960008c81527']);

var checkRequest = new CheckRequest
                    {
                        clientId = "5eb04fcd0f3e360008035eb1",
                        documentId = "5ebd40714f23960008c81527",
                        livePhotoId = "5eb1b5f231778a0008d1c3f6",
                        type = "identity_check"
                    };

var check = await checkApi.CreateAsync(checkRequest);

Exemple de réponse

La réponse contiendra un id (l’ID de vérification). Il est requis pour l’étape suivante.

{
    "id": "65c12a6426d2ab000814037e",
    "entityName": "John Doe",
    "type": "identity_check",
    "clientId": "5eb04fcd0f3e360008035eb1",
    "livePhotoId": "5eb1b5f231778a0008d1c3f6",
    "documentId": "5ebd40714f23960008c81527",
    "status": "pending",
    "createdAt": "2025-01-04T17:25:21.116Z",
    "updatedAt": "2025-01-04T17:25:21.116Z"
}

Récupérer les résultats

ComplyCube exécutera ensuite la vérification. Vous pouvez récupérer son résultat et son analyse détaillée via l’API, ou consulter les résultats dans le portail.

Si vous avez configuré des webhooks, vous recevrez également une notification une fois la vérification terminée.

Exemple de requête pour récupérer le résultat de la vérification

curl -X GET https://api.complycube.com/v1/checks/5ebd40714f23960008c81527 \\
     -H 'Authorization: <YOUR_API_KEY>'

Exemple de réponse

{
   "id": "5e94b88a01bce00008c86f06",
   "entityName": "John Doe",
   "type": "identity_check",
   "clientId": "5e94b75d01bce00008c86f02",
   "documentId": "5e94b87b01bce00008c86f03",
   "livePhotoId": "5e94b88901bce00008c86f05",
   "status": "complete",
   "result": {
      "outcome": "clear",
      "breakdown": {
         "faceAnalysis": {
            "faceDetection": "clear",
            "facialSimilarity": "clear",
            "breakdown": {
               "facialSimilarityScore": 100
            }
         },
         "authenticityAnalysis": {
            "spoofedImageAnalysis": "clear",
            "livenessCheck": "clear",
            "breakdown": {
               "livenessCheckScore": 100
            }
         },
         "integrityAnalysis": {
            "faceDetection": "clear"
         }
      }
   },
   "createdAt": "2025-01-04T17:25:21.116Z",
   "updatedAt": "2025-01-04T17:25:21.116Z"
}

PrécédentEffectuer une vérification de document SuivantEffectuer une vérification de justificatif de domicile