Criar processo AucoFace

POST/verifacechave privadaprk_

Serviço para a criação de um processo que permite validar, por meio de fotografias do documento e do rosto da pessoa, notificando o usuário por e-mail ou WhatsApp.

Autenticação

Inclua sua chave privada no cabeçalho Authorization.

Authorization: prk_xxx...

aviso

A notificação por e-mail só está disponível ao integrar o módulo auco-sdk-integration

Parâmetros de consulta

Nome	Descrição
email String	Obrigatório. E-mail do criador do processo. Este e-mail deve estar registrado na plataforma Auco e pertencer à empresa.
platform String	Obrigatório. Plataforma pela qual a validação será realizada. Valores aceitos: whatsapp, web
name String	Obrigatório. Nome da pessoa a ser validada.
phone String	Condicional. Obrigatório somente quando platform for whatsapp. Número de telefone com código do país da pessoa a ser validada. O formato aceito é +[Código do país][Número de telefone] Exemplo: +573003003030
country String	Obrigatório. País da pessoa a ser validada. Consulte a lista de documentos e países
type String	Obrigatório. Tipo de documento da pessoa a ser validada. Consulte a lista de documentos e países
identification String	Obrigatório. Número de identificação da pessoa a ser consultada.
userEmail String	Opcional. E-mail da pessoa a ser validada.
custom Object	Opcional. Aqui você pode salvar informações adicionais que precise incluir na notificação via webhook em cada etapa do fluxo. Exemplo: {"reference": "RF-XXXXXXX"}
expiredDate Date	Opcional. Data de expiração do documento. Deve ser superior a 3 dias a partir da data de criação do processo e é enviada no formato Date JSON.
targetWebhooks Array<String>	Opcional. Lista de webhooks a serem notificados. Se não for definida, será enviada ao webhook "default".
tags Array<String>	Opcional. Lista de tags a serem enviadas ao notificar os webhooks configurados.
validationTypes Array<String>	Opcional. Disponível somente quando platform for web. Tipos de validação a solicitar. Valores aceitos: photo, identification, identificationBack (mínimo 1, sem duplicatas). Se identificationBack for incluído, identification também deve ser incluído.

🧪 Exemplos de uso

Curl

curl -X POST '{{api_auco}}/veriface' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "platform": "whatsapp",
    "name": "Juan Pérez",
    "phone": "+573003003030",
    "country": "CO",
    "type": "CC",
    "identification": "1001001010"
  }'

Python

import requests

response = requests.post(
  '{{api_auco}}/veriface',
  headers={'Authorization': '{{private_key}}'},
  json={
    "email": "prueba@auco.ai",
    "platform": "whatsapp",
    "name": "Juan Pérez",
    "phone": "+573003003030",
    "country": "CO",
    "type": "CC",
    "identification": "1001001010"
  }
)
print(response.json())

Node.js

const axios = require('axios');

axios.post('{{api_auco}}/veriface', {
  email: "prueba@auco.ai",
  platform: "whatsapp",
  name: "Juan Pérez",
  phone: "+573003003030",
  country: "CO",
  type: "CC",
  identification: "1001001010"
}, {
  headers: { Authorization: '{{private_key}}' }
})
.then((response) => console.log(response.data));

📥 Exemplos de respostas

Criação bem-sucedida.

{
  "code": "VERIFACE_CODE"
}

Data de expiração incorreta.

{
  "message": "EXPIRED_DATE_INVALID"
}

⚠️ Respostas de erro

Código	Descrição
400	Parâmetros obrigatórios ausentes, como email, platform, name, phone, country, type ou identification. Formato incorreto para phone ou expiredDate.
401	Autenticação inválida ou ausente.