Créer un processus AucoFace

POST/verifaceclé privéeprk_

Service de création d'un processus permettant de valider, à l'aide de photographies du document et du visage de la personne, en notifiant l'utilisateur par e-mail ou par WhatsApp.

Authentification

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

Authorization: prk_xxx...

avertissement

La notification par e-mail n'est disponible qu'en intégrant le module auco-sdk-integration

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'entreprise.
platform String	Obligatoire. Plateforme par laquelle la validation sera effectuée. Valeurs acceptées : whatsapp, web
name String	Obligatoire. Nom de la personne à valider.
phone String	Conditionnel. Obligatoire uniquement lorsque platform vaut whatsapp. Numéro de téléphone avec indicatif du pays de la personne à valider. Le format accepté est +[Indicatif du pays][Numéro de téléphone] Exemple : +573003003030
country String	Obligatoire. Pays de la personne à valider. Consultez la liste des documents et des pays
type String	Obligatoire. Type de document de la personne à valider. Consultez la liste des documents et des pays
identification String	Obligatoire. Numéro d'identification de la personne à consulter.
userEmail String	Facultatif. E-mail de la personne à valider.
custom Object	Facultatif. Vous pouvez y enregistrer des informations supplémentaires à ajouter à la notification par webhook à chaque étape du flux. Exemple : {"reference": "RF-XXXXXXX"}
expiredDate Date	Facultatif. Date d'expiration du document. Elle doit être postérieure de plus de 3 jours à la date de création du processus et est envoyée au format Date JSON.
targetWebhooks Array<String>	Facultatif. Liste des webhooks à notifier. S'il n'est pas défini, l'envoi se fera au webhook « default ».
tags Array<String>	Facultatif. Liste des étiquettes à envoyer lors de la notification des webhooks configurés.
validationTypes Array<String>	Facultatif. Disponible uniquement lorsque platform vaut web. Types de validation à demander. Valeurs acceptées : photo, identification, identificationBack (minimum 1, sans doublons). Si identificationBack est inclus, identification doit l'être également.

🧪 Exemples d'utilisation

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

📥 Exemples de réponses

Création réussie.

{
  "code": "VERIFACE_CODE"
}

Date d'expiration incorrecte.

{
  "message": "EXPIRED_DATE_INVALID"
}

⚠️ Réponses d'erreur

Code	Description
400	Paramètres obligatoires manquants tels que email, platform, name, phone, country, type ou identification. Format incorrect pour phone ou expiredDate.
401	Authentification invalide ou absente.