Consulter les processus et les modèles

GET/documentclé publiquepuk_

Ce service vous permet de consulter vos processus de signature, vos modèles automatisés ou vos propres modèles automatisés dans Auco.

Authentification

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

Authorization: puk_xxx...

Paramètres de requête

Nom	Type	Description
`code`	String facultatif	Code du document associé au processus. Obligatoire si `package` n'est pas inclus.
`image`	String facultatif	Si `"true"`, inclut dans la réponse les images de la pièce d'identité et de la photo des signataires.

⚠️ Si vous n'envoyez pas l'attribut code, vous recevrez une liste de modèles automatisés.

info

Ce même endpoint peut également être utilisé pour récupérer un lot de documents, voir plus de détails dans récupérer des lots de documents.

🧪 Exemples d'utilisation

astuce

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

🔹 Obtenir les informations générales du processus

curl
Python
Node.js

curl --location 'https://api.auco.ai/v1.5/ext/document?code=CODEDOCUM' \
  --header 'Authorization: puk_yourPublicKey'

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/document",
  headers={"Authorization": "puk_yourPublicKey"},
  params={"code": "CODEDOCUM"}
)
print(response.json())

const axios = require('axios');

axios
  .get('https://api.auco.ai/v1.5/ext/document', {
    headers: { Authorization: 'puk_yourPublicKey' },
    params: { code: 'CODEDOCUM' },
  })
  .then((response) => console.log(response.data));

🔹 Obtenir le processus avec les images des signataires

En incluant le paramètre image=true, la réponse contiendra les images de la pièce d'identité et de la photo des signataires lorsqu'elles sont disponibles.

curl
Python
Node.js

curl --location 'https://api.auco.ai/v1.5/ext/document?code=CODEDOCUM&image=true' \
  --header 'Authorization: puk_yourPublicKey'

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/document",
  headers={"Authorization": "puk_yourPublicKey"},
  params={"code": "CODEDOCUM", "image": "true"}
)
print(response.json())

const axios = require('axios');

axios
  .get('https://api.auco.ai/v1.5/ext/document', {
    headers: { Authorization: 'puk_yourPublicKey' },
    params: { code: 'CODEDOCUM', image: 'true' },
  })
  .then((response) => console.log(response.data));

📥 Exemple de réponse

{
  "url": "https://signed_url",
  "name": "prueba firma garabato",
  "code": "CODEDOCUM",
  "status": "CREATED",
  "data": {
    "code": "CODEDOCUM",
    "name": "prueba firma garabato",
    "camera": false,
    "otpCode": false,
    "signFinish": false,
    "signProfile": [
      {
        "name": "Firmante de prueba",
        "email": "example@auco.ai",
        "id": "G8",
        "status": "NOTIFICATION"
      }
    ],
    "createdAt": "2025-01-02T16:54:00.297Z",
    "updatedAt": "2025-01-02T16:54:03.105Z"
  },
  "signProfile": [
    {
      "name": "Mauricio Lopez",
      "email": "example@auco.ai",
      "id": "G8",
      "status": "NOTIFICATION"
    }
  ],
  "custom": {
    "externalId": "ORDER-123",
    "source": "crm"
  }
}

info

Le champ custom n'apparaît que s'il a été envoyé lors de la création du processus (voir POST /document/upload). Il contient exactement les données envoyées par l'intégrateur, sans aucune transformation de la part d'Auco.

🔄 Statut du document (`status`)

Statut	Description
`CREATED`	Lorsque le processus a été créé.
`REJECTED`	Processus rejeté.
`EXPIRED`	Processus expiré, uniquement si une date d'expiration a été définie.
`FINISH`	Processus signé ou approuvé par toutes les parties.

🔄 Statut du participant (`status`)

Statut	Description
`NOTIFICATION`	Le participant a été notifié pour signer.
`REJECT`	Le participant a rejeté la signature ou l'approbation.
`FINISH`	Le participant a signé ou approuvé le processus.
`BLOCK`	Le participant a dépassé le nombre de tentatives échouées lors de la signature ou de l'approbation.
`PENDING`	Le participant n'a pas été notifié, généralement en raison d'un processus séquentiel.

🖼️ Images des signataires

Lorsque le paramètre image=true est envoyé, chaque objet de signProfile peut inclure les champs d'image suivants :

Champ	Description
`identificationCard`	Photo du recto de la pièce d'identité
`identificationCardBack`	Photo du verso de la pièce d'identité
`photo`	Selfie/photo du signataire

Format des images

Chaque champ d'image a la structure suivante :

{
  "type": "base64 | presigned",
  "data": "..."
}

Type	Contenu de `data`	Description
`base64`	`data:image/jpeg;base64,...`	L'image est encodée en base64
`presigned`	URL S3 (par ex. `https://s3...`)	URL signée valable 5 minutes

Exemple de réponse avec images

{
  "url": "https://signed_url",
  "name": "Contrat de services",
  "code": "CODEDOCUM",
  "status": "FINISH",
  "signProfile": [
    {
      "name": "John Smith",
      "email": "john@example.com",
      "id": "G8",
      "status": "FINISH",
      "identificationCard": {
        "type": "presigned",
        "data": "https://s3.amazonaws.com/bucket/..."
      },
      "identificationCardBack": {
        "type": "presigned",
        "data": "https://s3.amazonaws.com/bucket/..."
      },
      "photo": {
        "type": "base64",
        "data": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
      }
    }
  ]
}

avertissement

Les URL présignées sont valables 5 minutes. Veillez à télécharger les images avant leur expiration.

⚠️ Réponses d'erreur

Code	Description
400	Processus introuvable (`DOCUMENT_NOT_FOUND`)
401	Authentification invalide ou manquante

Authentification​

Paramètres de requête​

🧪 Exemples d'utilisation​

🔹 Obtenir les informations générales du processus​

🔹 Obtenir le processus avec les images des signataires​

📥 Exemple de réponse​

🔄 Statut du document (status)​

🔄 Statut du participant (status)​

🖼️ Images des signataires​

Format des images​

Exemple de réponse avec images​

⚠️ Réponses d'erreur​