Consultar processo AucoFace

GET/verifacechave públicapuk_

Serviço para consultar o status e os resultados de um processo AucoFace criado anteriormente.

Autenticação

Inclua sua chave pública no cabeçalho Authorization.

Authorization: puk_xxx...

Parâmetros de consulta

Nome	Descrição
code String	Obrigatório. Código do processo AucoFace a consultar. Deve ter exatamente 16 caracteres. Esse código é obtido ao criar o processo pelo endpoint `/veriface`.

Estrutura da resposta

A resposta contém as informações do processo AucoFace organizadas em diferentes seções:

Campos principais do processo

Campo	Tipo	Descrição
email	String	E-mail de quem criou o processo
createdAt	String	Data de criação do processo no formato `Date JSON`
platform	String	Plataforma utilizada: `whatsapp`, `web`
status	String	Status atual do processo veja os status do processo
emailValidated	String	E-mail de quem aprovou ou rejeitou a validação manual
name	String	Nome completo da pessoa a validar
userEmail	String	E-mail da pessoa a validar
phone	String	Número de telefone da pessoa a validar, com código do país
country	String	País da pessoa a validar. Consulte a lista de documentos e países
identificationType	String	Tipo de documento da pessoa a validar. Consulte a lista de documentos e países
identificationNumber	String	Número do documento de identidade da pessoa a validar
ocrData	Object	Dados extraídos do documento via OCR. Veja Dados OCR para alguns dos dados que podem ser obtidos.
attempts	Array	Lista das tentativas de validação realizadas
custom	Object	Informações adicionais incluídas na criação do processo
hash	String	Código de autenticidade e segurança do processo. Só é incluído depois que o processo termina e permite verificar sua integridade.
validationTypes	Array<String>	Tipos de validação solicitados na criação do processo (aplica-se apenas a processos criados com `platform: web`).

Status do processo

Status	Descrição
INPROGRESS	Processo em andamento, o usuário está realizando a validação
BLOCKED	O usuário excedeu o número máximo de tentativas, requer validação manual na plataforma
APPROVED	Validação concluída com sucesso, documentos e dados biométricos são válidos
INVALIDATED	Processo concluído, mas a validação não foi bem-sucedida
EXPIRED	O processo expirou sem ser concluído dentro do prazo

Informações da tentativa (Array `attempts`)

Cada tentativa pode conter todas ou parte das seguintes informações:

Campo	Descrição
identificationCardFront	URL temporária da imagem da frente do documento
identificationCardBack	URL temporária da imagem do verso do documento
photo	URL temporária da fotografia do rosto
similarity	Porcentagem de similaridade biométrica (0-100)
identificationCardData	Dados extraídos do documento via OCR
date	Data e hora da tentativa
successful	Booleano que indica se a tentativa foi bem-sucedida
errorMessages	Array de erros em caso de falha

Dados OCR (`ocrData`)

Informações extraídas do documento de identidade:

Dados pessoais: fullName, givenNames, surname, documentNumber
Informações demográficas: dateOfBirth, sex, bloodGroup, height
Dados do documento: documentType, firstIssueDate, placeOfIssue
Localização: issuingStateName, placeOfBirth

URLs temporárias

As URLs das imagens (identificationCardFront, identificationCardBack, photo) são links temporários do AWS S3 com validade de 5 minutos. Depois desse prazo, será necessário fazer uma nova consulta para obter URLs atualizadas.

Disponibilidade dos dados

O campo ocrData só está disponível quando foi possível extrair informações do documento
O array attempts pode conter várias tentativas se o usuário realizou várias validações
Os dados OCR podem variar conforme o tipo de documento, o país e a qualidade da imagem

🧪 Exemplos de uso

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

📥 Exemplos de respostas

Processo aprovado.
Processo em andamento.
Processo bloqueado.
Processo invalidado.

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

⚠️ Respostas de erro

Código	Descrição
400	Código de processo inválido ou malformado.
401	Autenticação inválida ou ausente.

Autenticação​

Parâmetros de consulta​

Estrutura da resposta​

Campos principais do processo​

Status do processo​

Informações da tentativa (Array attempts)​

Dados OCR (ocrData)​

🧪 Exemplos de uso​

📥 Exemplos de respostas​

⚠️ Respostas de erro​