Flux du document

Pour chaque état du document, une requête est générée avec le corps suivant, seule la description du statut variant.

Vous disposez de 10 secondes pour répondre

Auco ferme la connexion si votre point de terminaison ne répond pas dans un délai de 10 secondes. Un dépassement de délai comme une réponse 4xx ou 5xx sont retentés jusqu'à 3 fois avant que la notification ne soit abandonnée. Renvoyez 200 immédiatement, traitez en arrière-plan et rendez votre gestionnaire idempotent. Voir Délai de réponse et nouvelles tentatives.

---

États notifiés

Nom	Description
CREATE	Notifié lorsqu'un document est créé ou qu'un PDF est téléversé sur la plateforme.
FINISH	Notifié lorsque toutes les parties ont signé le document.
NOTIFICATION	Notifié lorsqu'un participant du document a terminé le processus de signature.
REJECT	Notifié lorsqu'au moins un signataire a rejeté le document.
REJECTED	Indique le détail de l'annulation du processus.
BLOCKED	Notifié lorsqu'un signataire dépasse le nombre de tentatives de validation d'identité (3), ou est arrêté par le garde d'identité, nécessitant une validation manuelle.
EXPIRED	Notifié lorsqu'un document expire, uniquement si une date d'expiration a été définie lors de la création.

---

🧪 Exemples de notification

astuce

Vous pouvez copier n'importe lequel des exemples selon votre langage préféré.

Paramètres de la réponse

Nom	Type	Description
code	String	Code du document.
name	String	Nom du document.
signer	Object	Informations sur le signataire, présentes uniquement lorsque le statut est NOTIFICATION, BLOCKED ou REJECTED.
url	String	URL du document.
status	String	Statut actuel du processus de signature (CREATE, FINISH, NOTIFICATION, REJECT, REJECTED, BLOCKED ou EXPIRED).
message	String	Contenu textuel associé au statut du signataire. Si le statut est REJECTED, contient le message individuel rédigé par le participant. Pour BLOCKED, voir la liste des états de blocage.
similarity	Number	Pourcentage de similarité de la validation faciale d'identité, présent le cas échéant.
scores	Object	Détail des scores de la validation d'identité, présent le cas échéant.
signals	Array	Signaux du garde d'identité ([{ code, severity }]), présents dans NOTIFICATION et BLOCKED lorsque la validation est passée par le garde. Voir Signaux du garde d'identité.
tags	Array	Liste des étiquettes attribuées au document, si elles ont été définies lors de la création.
custom	Array	Liste des champs personnalisés enregistrés dans le document, le cas échéant.

Création du processus

JSON

{
  "code": "DOCUMENTCODE", //Código del documento
  "name": "Contrato de prueba del API", //Nombre del documento
  "status": "CREATE", //Estado del documento
  "url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf" // url del documento
}

Fin du processus

JSON

{
  "code": "DOCUMENTCODE",
  "name": "Contrato de prueba del API",
  "status": "FINISH",
  "url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf" // url del documento
}

Signature d'un participant

JSON

{
  "code": "DOCUMENTCODE",
  "name": "Contrato de prueba del API",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "NOTIFICATION",
  "signals": [{ "code": "ALERT_EMAIL_CHANGED", "severity": "INFO" }]
}

Signataire bloqué

JSON

{
  "name": "document name",
  "signer": {
    "id": "participan_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "OTP_CODE_INVALID",
  "tags": ["document tag"],
  "custom": ["{'info':'required', 'definition': 'urgent'}"]
}

Bloqué par le garde d'identité

JSON

{
  "code": "DOCUMENTCODE",
  "name": "document name",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "IDENTITY_GUARD_BLOCKED",
  "signals": [
    { "code": "ALERT_FACE", "severity": "ALERT" },
    { "code": "ALERT_EMAIL_CHANGED", "severity": "INFO" }
  ]
}

Détail du rejet

JSON

{
  "name": "document name",
  "signer": {
    "id": "participan_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "REJECTED",
  "message": "message",
  "tags": ["document tags"]
}

Expiration du processus

JSON

{
  "code": "DOCUMENTCODE",
  "name": "Contrato de prueba del API",
  "status": "EXPIRED",
  "url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf",
  "tags": ["document tag"],
  "custom": ["{'info':'required', 'definition': 'urgent'}"]
}