Récupérer le processus et les pièces jointes

GET/attachmentsclé publiquepuk_

Ce service vous permet de récupérer les pièces jointes téléversées par les signataires au sein d'un processus. La structure de la réponse varie selon que le paramètre userId est inclus ou non.

---

Authentification

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

Authorization: puk_xxx...

---

Paramètres de requête

Nom	Type	Description
package	String conditionnel	Identifiant du lot (package) du processus. Obligatoire si code n'est pas fourni.
code	String conditionnel	Code du document du processus. Obligatoire si package n'est pas fourni.
userId	String facultatif	Identifiant de l'utilisateur pour récupérer ses pièces jointes individuelles et son statut.

⚠️ Un seul des paramètres package ou code doit être envoyé. Si les deux sont fournis, la requête est rejetée avec une erreur 400.

---

Combinaisons d'utilisation valides

Méthode	Chemin	Description
GET	/attachments?package={packageId}	Consultation générale du processus
GET	/attachments?code={code}	Consultation générale du processus
GET	/attachments?package={packageId}&userId={userId}	Consultation des pièces jointes par signataire avec package
GET	/attachments?code={code}&userId={userId}	Consultation des pièces jointes par signataire avec code

---

🧪 Exemples d'utilisation

astuce

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

🔹 Obtenir les informations générales du processus

curl

curl --location 'https://api.auco.ai/v1.5/ext/attachments?package=package123' \
  --header 'Authorization: puk_yourPublicKey'

Python

import requests

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

Node.js

const axios = require('axios');

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

---

🔸 Obtenir les pièces jointes d'un signataire avec package et userId

curl

curl --location 'https://api.auco.ai/v1.5/ext/attachments?package=package456&userId=userX' \
  --header 'Authorization: puk_yourPublicKey'

Python

import requests

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

Node.js

const axios = require('axios');

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

---

🔸 Obtenir les pièces jointes d'un signataire avec code et userId

curl

curl --location 'https://api.auco.ai/v1.5/ext/attachments?code=codeABC&userId=userY' \
  --header 'Authorization: puk_yourPublicKey'

Python

import requests

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

Node.js

const axios = require('axios');

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

---

📥 Exemples de réponse

🔹 Sans userId

{
  "package": "package123",
  "name": "Signing Process 001",
  "finish": true,
  "signers": [
    {
      "userId": "01",
      "email": "user1@example.com",
      "name": "User One"
    }
  ]
}

🔸 Avec userId

{
  "package": "package123",
  "name": "Signing Process 001",
  "finish": true,
  "signer": {
    "userId": "01",
    "email": "user1@example.com",
    "name": "User One",
    "files": [
      {
        "name": "ID Document",
        "url": "https://..."
      },
      {
        "name": "Proof",
        "url": "https://..."
      }
    ],
    "status": "approved"
  }
}

---

🔄 Statut du signataire (status)

Statut	Description
pending	L'utilisateur n'a encore téléversé aucun document.
uploaded	L'utilisateur a téléversé des documents, mais ils n'ont pas encore été approuvés.
approved	Tous les documents ont été téléversés et approuvés.

Les URL des fichiers (url) ne sont incluses que si le status n'est pas pending. Il s'agit d'URL signées temporaires, valables 5 minutes (300 secondes) ; une fois expirées, appelez de nouveau le point de terminaison pour obtenir de nouveaux liens.

---

🔚 Champ finish

Le champ finish: true signifie que le processus est entièrement terminé et qu'aucune autre action n'est attendue.

---

⚠️ Réponses d'erreur

Code	Description
400	package ou code manquant, ou processus introuvable (ATTACHMENT_NOT_FOUND)
401	Authentification invalide ou absente