Gerar

POST/validate/backgroundchave privadaprk_

Serviço para gerar uma verificação de antecedentes para um usuário. A validação gerada pode levar até 1 minuto para ficar disponível para consulta pelo serviço de consulta.

Autenticação

Inclua sua chave privada no cabeçalho Authorization.

Authorization: prk_xxx...

Parâmetros de consulta

Nome	Descrição
email String	Obrigatório. E-mail de quem criou o processo. Esse e-mail deve estar cadastrado na plataforma Auco e pertencer à organização.
identification String	Obrigatório. Número de identificação da pessoa a ser consultada.
type String	Obrigatório. Tipo de documento de identificação da pessoa a ser verificada. Veja Tipos de documento aceitos.
name String	Condicional. Nome completo da pessoa a ser verificada. Obrigatório conforme o type (veja a tabela).
expeditionDate String	Condicional. Data de emissão do documento de identificação. Obrigatório conforme o type (veja a tabela). Formato aceito: 01/01/1995
targetWebhooks Array<String>	Opcional. Lista de webhooks a serem notificados. Se não for definido, será enviado ao webhook "default".
tags Array<String>	Opcional. Lista de tags a serem enviadas ao notificar os webhooks configurados.
custom Object	Opcional. Objeto livre que é armazenado junto com o processo e repassado nas notificações dos webhooks.

Tipos de documento aceitos

O valor de type determina quais campos adicionais são obrigatórios.

type	Documento	Campos adicionais obrigatórios
CC	Cédula de cidadania	—
CE	Cédula de estrangeiro	—
NIT	NIT	—
PPT	Permissão de Proteção Temporária	expeditionDate
PP	Passaporte	name
INT	Internacional	name

🧪 Exemplos de uso

Curl

curl -X POST '{{api_auco}}/validate/background' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "type": "CC",
    "identification": "1001001010",
    "expeditionDate": "01/01/1995"
  }'

Python

import requests

response = requests.post(
  '{{api_auco}}/validate/background',
  headers={'Authorization': '{{private_key}}'},
  json={
    "email": "prueba@auco.ai",
    "type": "CC",
    "identification": "1001001010",
    "expeditionDate": "01/01/1995"
  }
)
print(response.json())

Node.js

var axios = require('axios');

axios.post('{{api_auco}}/validate/background', {
  email: "prueba@auco.ai",
  type: "CC",
  identification: "1001001010",
  expeditionDate: "01/01/1995"
}, {
  headers: { Authorization: '{{private_key}}' }
})
.then((response) => console.log(response.data))

Passaporte (PP)

curl -X POST '{{api_auco}}/validate/background' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "type": "PP",
    "identification": "AB123456",
    "name": "FULL NAME"
  }'

Internacional (INT)

curl -X POST '{{api_auco}}/validate/background' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "type": "INT",
    "identification": "AB123456",
    "name": "FULL NAME"
  }'

📥 Exemplos de respostas

Validação bem-sucedida.

{
  "name": "NAME",
  "code": "XXXXXXXXX"
}

⚠️ Respostas de erro

Código	Descrição
400	Parâmetros ausentes, como email, type ou identification. name ausente quando type é PP ou INT, ou expeditionDate ausente quando type é PPT. Formato incorreto de expeditionDate.
401	Autenticação inválida ou ausente.