Générer

POST/validate/backgroundclé privéeprk_

Service permettant de générer une vérification des antécédents pour un utilisateur. La validation générée peut prendre jusqu'à 1 minute avant de pouvoir être récupérée via le service de consultation.

Authentification

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

Authorization: prk_xxx...

Paramètres de requête

Nom	Description
email String	Obligatoire. E-mail du créateur du processus. Cet e-mail doit être enregistré sur la plateforme Auco et appartenir à l'organisation.
identification String	Obligatoire. Numéro d'identification de la personne à consulter.
type String	Obligatoire. Type de document d'identité de la personne à vérifier. Voir Types de documents acceptés.
name String	Conditionnel. Nom complet de la personne à vérifier. Obligatoire selon le type (voir le tableau).
expeditionDate String	Conditionnel. Date de délivrance du document d'identité. Obligatoire selon le type (voir le tableau). Format accepté : 01/01/1995
targetWebhooks Array<String>	Facultatif. Liste des webhooks à notifier. S'il n'est pas défini, la notification sera envoyée au webhook « default ».
tags Array<String>	Facultatif. Liste de tags à envoyer lors de la notification des webhooks configurés.
custom Object	Facultatif. Objet libre conservé avec le processus et transmis dans les notifications des webhooks.

Types de documents acceptés

La valeur de type détermine quels champs supplémentaires sont obligatoires.

type	Document	Champs supplémentaires obligatoires
CC	Carte d'identité de citoyen	—
CE	Carte d'étranger	—
NIT	NIT	—
PPT	Permis de protection temporaire	expeditionDate
PP	Passeport	name
INT	International	name

🧪 Exemples d'utilisation

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

Passeport (PP)

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

International (INT)

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

📥 Exemples de réponses

Validation réussie.

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

⚠️ Réponses d'erreur

Code	Description
400	Paramètres manquants tels que email, type ou identification. name manquant lorsque type vaut PP ou INT, ou expeditionDate manquant lorsque type vaut PPT. Format incorrect pour expeditionDate.
401	Authentification invalide ou manquante.