Consulter un processus AucoFace

GET/verifaceclé publiquepuk_

Service permettant de consulter le statut et les résultats d'un processus AucoFace créé précédemment.

Authentification

Incluez votre clé publique dans l'en-tête Authorization.

Authorization: puk_xxx...

Paramètres de requête

Nom	Description
code String	Obligatoire. Code du processus AucoFace à consulter. Doit comporter exactement 16 caractères. Ce code est obtenu lors de la création du processus via le endpoint `/veriface`.

Structure de la réponse

La réponse contient les informations du processus AucoFace organisées en différentes sections :

Champs principaux du processus

Champ	Type	Description
email	String	E-mail du créateur du processus
createdAt	String	Date de création du processus au format `Date JSON`
platform	String	Plateforme utilisée : `whatsapp`, `web`
status	String	Statut actuel du processus voir les statuts du processus
emailValidated	String	E-mail de la personne qui a approuvé ou rejeté la validation manuelle
name	String	Nom complet de la personne à valider
userEmail	String	E-mail de la personne à valider
phone	String	Numéro de téléphone de la personne à valider, avec l'indicatif du pays
country	String	Pays de la personne à valider. Consultez la liste des documents et des pays
identificationType	String	Type de document de la personne à valider. Consultez la liste des documents et des pays
identificationNumber	String	Numéro du document d'identité de la personne à valider
ocrData	Object	Données extraites du document par OCR. Voir Données OCR pour quelques-unes des données pouvant être obtenues.
attempts	Array	Liste des tentatives de validation effectuées
custom	Object	Informations supplémentaires ajoutées lors de la création du processus
hash	String	Code d'authenticité et de sécurité du processus. Inclus uniquement une fois le processus terminé, il permet de vérifier son intégrité.
validationTypes	Array<String>	Types de validation demandés lors de la création du processus (s'applique uniquement aux processus créés avec `platform: web`).

Statuts du processus

Statut	Description
INPROGRESS	Processus en cours, l'utilisateur effectue la validation
BLOCKED	L'utilisateur a dépassé le nombre maximal de tentatives, une validation manuelle est requise sur la plateforme
APPROVED	Validation terminée avec succès, les documents et les données biométriques sont valides
INVALIDATED	Processus terminé, mais la validation n'a pas abouti
EXPIRED	Le processus a expiré sans être terminé dans le délai imparti

Informations sur les tentatives (Array `attempts`)

Chaque tentative peut contenir tout ou partie des informations suivantes :

Champ	Description
identificationCardFront	URL temporaire de l'image du recto du document
identificationCardBack	URL temporaire de l'image du verso du document
photo	URL temporaire de la photographie du visage
similarity	Pourcentage de similarité biométrique (0-100)
identificationCardData	Données extraites du document par OCR
date	Horodatage de la tentative
successful	Booléen indiquant si la tentative a réussi
errorMessages	Tableau d'erreurs en cas d'échec

Données OCR (`ocrData`)

Informations extraites du document d'identité :

Données personnelles : fullName, givenNames, surname, documentNumber
Informations démographiques : dateOfBirth, sex, bloodGroup, height
Données du document : documentType, firstIssueDate, placeOfIssue
Localisation : issuingStateName, placeOfBirth

URL temporaires

Les URL des images (identificationCardFront, identificationCardBack, photo) sont des liens AWS S3 temporaires d'une validité de 5 minutes. Passé ce délai, il sera nécessaire d'effectuer une nouvelle requête pour obtenir des URL à jour.

Disponibilité des données

Le champ ocrData n'est disponible que lorsqu'il a été possible d'extraire des informations du document
Le tableau attempts peut contenir plusieurs tentatives si l'utilisateur a effectué plusieurs validations
Les données OCR peuvent varier selon le type de document, le pays et la qualité de l'image

🧪 Exemples d'utilisation

Curl
Python
Node.js

curl -X GET '{{api_auco}}/veriface?code=VERIFACE_CODE' \
  -H 'Authorization: {{public_key}}'

import requests

response = requests.get(
  '{{api_auco}}/veriface',
  params={'code': 'VERIFACE_CODE'},
  headers={'Authorization': '{{public_key}}'}
)
print(response.json())

const axios = require('axios');

axios.get('{{api_auco}}/veriface', {
  params: { code: 'VERIFACE_CODE' },
  headers: { Authorization: '{{public_key}}' }
})
.then((response) => console.log(response.data));

📥 Exemples de réponses

Processus approuvé.
Processus en cours.
Processus bloqué.
Processus invalidé.

{
  "email": "prueba@auco.ai",
  "createdAt": "2025-05-29T14:53:04.074Z",
  "platform": "whatsapp",
  "status": "APPROVED",
  "name": "Juan Pérez",
  "userEmail": "juan.perez@gmail.com",
  "phone": "+573003003030",
  "country": "CO",
  "identificationType": "CC",
  "identificationNumber": "1001001010",
  "hash": "b1946ac92492d2347c6235b4d2611184a1e2e3b9f3a3a0c1e8f3e0e0e0e0e0e0",
  "attempts": [
    {
      "identificationCardFront": "https://amazon.url/file/signed-url",
      "identificationCardBack": "https://amazon.url/file/signed-url",
      "photo": "https://amazon.url/file/signed-url",
      "similarity": 91.31532287597656,
      "identificationCardData": {
        "documentNumber": "1001001010",
        "fullName": "PÉREZ JUAN",
        "givenNames": "JUAN",
        "issuingStateName": "Colombia",
        "surname": "PÉREZ",
        "documentType": "Id Card",
        "name": "JUAN PÉREZ"
      },
      "date": "2025-05-29T17:16:51.839Z",
      "successful": true
    }
  ],
  "ocrData": {
    "bloodGroup": "O+",
    "dateOfBirth": "1990-05-15",
    "firstIssueDate": "2015-03-20",
    "height": "175 cm",
    "issuingStateName": "Colombia",
    "placeOfBirth": "BOGOTÁ (CUNDINAMARCA)",
    "sex": "M",
    "documentType": "Id Card",
    "placeOfIssue": "BOGOTÁ",
    "documentNumber": "1001001010",
    "fullName": "PÉREZ JUAN",
    "givenNames": "JUAN",
    "surname": "PÉREZ",
    "name": "JUAN PÉREZ"
  }
}

{
  "email": "prueba@auco.ai",
  "createdAt": "2025-05-29T14:53:04.074Z",
  "platform": "whatsapp",
  "status": "INPROGRESS",
  "name": "Juan Pérez",
  "userEmail": "juan.perez@gmail.com",
  "phone": "+573003003030",
  "country": "CO",
  "identificationType": "CC",
  "identificationNumber": "1001001010",
  "attempts": []
}

{
  "email": "prueba@auco.ai",
  "createdAt": "2025-05-29T14:53:04.074Z",
  "platform": "whatsapp",
  "status": "BLOCKED",
  "emailValidated": "supervisor@auco.ai",
  "name": "Juan Pérez",
  "phone": "+573003003030",
  "country": "CO",
  "identificationType": "CC",
  "identificationNumber": "1001001010",
  "attempts": [
    {
      "identificationCardFront": "https://amazon.url/file/signed-url",
      "photo": "https://amazon.url/file/signed-url",
      "similarity": 45.23456789,
      "identificationCardData": {
        "documentNumber": "1001001010",
        "fullName": "PÉREZ JUAN",
        "documentType": "Id Card"
      },
      "date": "2025-05-29T17:15:31.383Z",
      "errorMessages": [
        {
          "key": "ID_BACK",
          "error": "error_identification_not_document"
        }
      ],
      "successful": false
    }
  ]
}

{
  "email": "prueba@auco.ai",
  "createdAt": "2025-05-29T14:53:04.074Z",
  "platform": "web",
  "status": "INVALIDATED",
  "name": "Juan Pérez",
  "phone": "+573003003030",
  "country": "CO",
  "identificationType": "CC",
  "identificationNumber": "1001001010",
  "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "attempts": [
    {
      "identificationCardFront": "https://amazon.url/file/signed-url",
      "photo": "https://amazon.url/file/signed-url",
      "similarity": 32.15432167891234,
      "date": "2025-05-29T17:15:31.383Z",
      "errorMessages": [
        {
          "key": "ID_BACK",
          "error": "error_identification_not_document"
        }
      ],
      "successful": false
    }
  ]
}

⚠️ Réponses d'erreur

Code	Description
400	Code de processus invalide ou mal formé.
401	Authentification invalide ou manquante.

Authentification​

Paramètres de requête​

Structure de la réponse​

Champs principaux du processus​

Statuts du processus​

Informations sur les tentatives (Array attempts)​

Données OCR (ocrData)​

🧪 Exemples d'utilisation​

📥 Exemples de réponses​

⚠️ Réponses d'erreur​