Generar validación de antecedentes

POST/validate/backgroundllave privadaprk_

Servicio para realizar generar la validación de antecedentes de un usuario. La validación generada puede tardar hasta 1 minuto en estar lista para poder ser consultada mediante el servicio de consulta.

Autenticación

Incluye tu llave privada en el encabezado Authorization.

Authorization: prk_xxx...

Parámetros de consulta

Nombre	Descripción
email String	Obligatorio. Correo electrónico del creador del proceso. Este correo debe estar registrado en la plataforma de Auco y debe pertenecer a la organización.
identification String	Obligatorio. Número de identificación de la persona a consultar.
type String	Obligatorio. Tipo de documento de identificación de la persona a consultar. Ver Tipos de documento aceptados.
name String	Condicional. Nombre completo de la persona a consultar. Requerido según el type (ver tabla).
expeditionDate String	Condicional. Fecha de expedicion del documento de identificación. Requerida según el type (ver tabla). Formato aceptado: 01/01/1995
targetWebhooks Array<String>	Opcional. Lista de webhooks a ser notificados. En caso de no definir se envia al webhook "default".
tags Array<String>	Opcional. Lista de tags que se envian cuando notifique al los webhooks configurados.
custom Object	Opcional. Objeto libre que se almacena junto al proceso y se reenvía en las notificaciones de webhook.

Tipos de documento aceptados

El valor de type determina qué campos adicionales son obligatorios.

type	Documento	Campos adicionales requeridos
CC	Cédula de ciudadanía	—
CE	Cédula de extranjería	—
NIT	NIT	—
PPT	Permiso por Protección Temporal	expeditionDate
PP	Pasaporte	name
INT	Internacional	name

Auco verifica el documento antes de consultar

Con type en CC, CE, PPT o NIT, Auco verifica que el documento exista antes de hacer la consulta de antecedentes. Si no existe, no se hace ni se cobra la consulta. Ver más

🧪 Ejemplos 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

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

Pasaporte (PP)

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

Internacional (INT)

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

📥 Ejemplos de respuesta

Validación exitosa.

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

⚠️ Respuestas de error

Código	Descripción
400	Faltan parámetros como email, type o identification. Falta name cuando type es PP o INT, o expeditionDate cuando type es PPT. Formato incorrecto de expeditionDate. El documento no existe o su titular figura como fallecido: IDENTITY_NOT_FOUND, IDENTITY_DECEASED o, con NIT, COMPANY_NOT_FOUND. Ver más
401	Autenticación inválida o ausente.