Realizar comprobación de identidad

Usa la API para ejecutar comprobaciones de verificación de identidad y validar los datos del cliente para KYC.

Resumen

Esta guía le muestra cómo realizar una verificación de identidad usando la API de ComplyCube.

Puedes probar esta verificación de inmediato usando nuestra Colección de demostración de Postman. Es de acceso público y no requiere una cuenta.

Pasos de integración

Crear un cliente

El primer paso para crear cualquier comprobación es añadir un cliente desde su servidor backend. Un cliente puede representar a una persona o una empresa.

La respuesta contendrá un id (el ID del cliente). Es necesario para el siguiente paso.

Ejemplo de solicitud para crear un cliente

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);

Respuesta de ejemplo

{
    "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"
}

Crear una foto en vivo

Suba una imagen selfie del cliente codificada en BASE64. La imagen debe estar en JPG o PNG y tener un tamaño entre 34 KB y 4 MB .

A continuación se muestra una imagen selfie de ejemplo codificada en BASE64. Descárguela y copie su contenido. Luego péguelo en el data atributo al hacer la solicitud.

La respuesta contendrá un id (el ID de la foto en vivo). Se requerirá más adelante.

Ejemplo de solicitud para subir la foto en vivo

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);

Ejemplo de respuesta

{
    "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"
}

Crear un documento

Cree un documento proporcionando el ID del cliente y tipo de documento (p. ej., pasaporte, documento nacional de identidad).

La respuesta contendrá un id (el ID del documento). Es necesario para el siguiente paso.

Ejemplo de solicitud para crear un documento

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

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

var document = await docApi.CreateAsync(docRequest);

Respuesta de ejemplo

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

Subir el anverso del documento de identidad

Suba una imagen codificada en BASE64 de la parte frontal del documento de identidad. Dependiendo del tipo de documento y del país emisor, pueden requerirse ambos lados.

Las imágenes deben estar en JPG, PNG, o PDF formato y entre 34 KB y 4 MB de tamaño.

A continuación se muestra un archivo de ejemplo codificado en BASE64. Descárguelo, copie su contenido y péguelo en el data atributo al realizar la solicitud.

Solicitud de ejemplo para subir la imagen del anverso de un documento

 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(
    "5ebd40714f23960008c81527", 
    "front", 
    docFront
);

Respuesta de ejemplo

{
    "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"
}

Crear una verificación de identidad

Cree una verificación de identidad especificando el ID del cliente, ID de la foto en vivo, ID del documento, y el tipo de verificación.

La respuesta contendrá un id (el ID de la verificación). Se requiere para el siguiente paso.

Ejemplo de solicitud para crear una verificación

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);

Ejemplo de respuesta

La respuesta contendrá un id (el ID de la verificación). Se requiere para el siguiente paso.

{
    "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"
}

Recuperar resultados

ComplyCube ejecutará entonces la verificación. Puede recuperar su resultado y desglose detallado a través de la API, o revisar los resultados en el Portal.

Si ha configurado webhooks, también recibirá una notificación una vez que la verificación se complete.

Ejemplo de solicitud para recuperar el resultado de la verificación

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

Ejemplo de respuesta

{
   "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"
}

AnteriorRealizar comprobación de documentos SiguienteRealizar comprobación de comprobante de domicilio