Lot de documents

Pour chaque état du lot de documents, une requête est générée avec le corps suivant, la description du statut variant selon le cas.

Vous disposez de 10 secondes pour répondre

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

---

États notifiés

Nom	Description
CREATE	Cet état est notifié lorsqu’un lot de documents est créé.
NOTIFICATION	Cet état est notifié lorsqu’un participant du lot a terminé sa signature.
SIGNED_PACKAGE	Cet état est notifié lorsque toutes les parties ont signé le lot de documents.
DOCUMENT_REJECT	Cet état est notifié lorsqu’un des documents du lot a été rejeté.
REJECTED	Cet état est notifié avec les informations du participant qui a rejeté le lot.
BLOCKED	Notifié lorsqu’un signataire dépasse le nombre de tentatives de validation d’identité (3), ou est arrêté par la protection d’identité, ce qui nécessite une validation manuelle.

---

🧪 Exemples de notifications

astuce

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

Paramètres de la notification

Nom	Type	Description
package	String	Identifiant du lot de documents.
name	String	Nom du lot de documents.
status	String	Statut actuel du lot (CREATE, NOTIFICATION, SIGNED_PACKAGE, DOCUMENT_REJECT, REJECTED ou BLOCKED).
signer	Object	Informations sur le signataire, présentes lorsque le statut est NOTIFICATION, REJECTED ou BLOCKED.
message	String	Message associé au statut du signataire. Si le statut est REJECTED, contient le message rédigé par le participant lors du rejet ; si BLOCKED, contient le motif du blocage.
documents	Array	Liste des documents faisant partie du lot (absente dans les états NOTIFICATION et REJECTED).
documents.code	String	Code du document.
documents.name	String	Nom du document.
documents.status	String	Statut individuel du document (CREATE, FINISH, REJECT ou EXPIRED).
documents.url	String	URL du document.
signals	Array	Signaux de la protection d’identité ([{ code, severity }]), présents dans NOTIFICATION et BLOCKED lorsque la validation est passée par cette protection. Consultez Signaux de la protection d’identité.
tags	Array	Liste des étiquettes ou champs personnalisés attribués au lot, s’ils sont définis.

Création du processus

JSON

{
  "package": "idPackage", //Package identifier
  "name": "API test documents", //Document package name
  "status": "CREATE", //Document package status
  "documents": [
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 1",
      "status": "CREATE",
      "url": "https://test.auco.ai/contrato-de-prueba1.pdf"
    },
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 2",
      "status": "CREATE",
      "url": "https://test.auco.ai/contrato-de-prueba2.pdf"
    }
  ]
}

Signature d’un participant

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "NOTIFICATION",
  "signals": [{ "code": "ALERT_EMAIL_CHANGED", "severity": "INFO" }]
}

Fin du processus

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "status": "SIGNED_PACKAGE",
  "documents": [
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 1",
      "status": "FINISH",
      "url": "https://test.auco.ai/contrato-de-prueba1.pdf"
    },
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 2",
      "status": "FINISH",
      "url": "https://test.auco.ai/contrato-de-prueba2.pdf"
    }
  ]
}

Rejet d’un document

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "status": "DOCUMENT_REJECT",
  "documents": [
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 1",
      "status": "REJECT",
      "url": "https://test.auco.ai/contrato-de-prueba1.pdf"
    },
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 2",
      "status": "CREATE",
      "url": "https://test.auco.ai/contrato-de-prueba2.pdf"
    }
  ]
}

Rejet par un participant

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "REJECTED",
  "message": "message"
}

Signataire bloqué

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "OTP_CODE_INVALID"
}

Bloqué par la protection d’identité

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "IDENTITY_GUARD_BLOCKED",
  "signals": [{ "code": "REPORT_PHONE", "severity": "REPORT" }]
}