Consultation de paquet

GET/documentclé publiquepuk_

Ce service vous permet de consulter les paquets de documents dans Auco.

---

Authentification

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

Authorization: puk_xxx...

---

Paramètres de requête

Nom	Type	Description
package	String facultatif	Identifiant du paquet de documents. Obligatoire si code n'est pas fourni.

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

info

Ce même endpoint peut également être utilisé pour obtenir des informations sur un document spécifique. Pour en savoir plus, consultez consulter les processus et les modèles

---

🧪 Exemples d'utilisation

astuce

Vous pouvez copier l'un des exemples en fonction de votre langage de programmation préféré.

🔹 Obtenir les informations générales du processus

curl

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

Python

import requests

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

Node.js

const axios = require('axios');

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

---

📥 Exemple de réponse

{
  "_id": "ID_PACKAGE",
  "codes": ["CODEDOC1", "CODEDOC2"],
  "name": "Prueba paquete de documentos",
  "signers": [
    {
      "userId": "AI",
      "email": "example1@auco.ai",
      "name": "Firmante 1",
      "phone": "+573000000000",
      "status": "NOTIFICATION"
    },
    {
      "userId": "OR",
      "email": "example2@auco.ai",
      "name": "Firmante 2",
      "phone": "+573000000000",
      "status": "NOTIFICATION"
    }
  ],
  "signFinish": false,
  "createdAt": "2024-10-18T20:20:34.970Z",
  "updatedAt": "2024-11-15T02:02:12.775Z",
  "status": "CREATED",
  "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 paquet (voir POST /document/many). 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 à la création.
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 du processus.
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.

---

⚠️ Réponses d'erreur

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