Annuler le processus de signature

POST/document/cancelclé privéeprk_

Ce service vous permet d'annuler un ou plusieurs documents. Il informe les signataires que le ou les documents ont été annulés, avec un message expliquant le motif de l'annulation.

info

Pour annuler un document, celui-ci ne doit pas être entièrement signé ni avoir été rejeté auparavant.

astuce

Cette action est également notifiée par WEBHOOK.

---

Authentification

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

Authorization: prk_xxx...

---

Paramètres de création

Nom	Type	Description
codes	Array obligatoire	Liste des codes de documents à annuler, par ex. : ['TR99AQMY31']
message	String obligatoire	Paramètre qui indique le message justifiant l'annulation ; ce message est envoyé aux signataires qui ont été notifiés auparavant ou qui ont déjà signé.
email	String obligatoire	Ce paramètre est envoyé lorsqu'il est nécessaire de conserver une trace de l'utilisateur qui annule le document.

---

🧪 Exemples d'utilisation

Annuler un processus

curl

curl --location 'https://api.auco.ai/v1.5/ext/document/cancel' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
    "codes":["DOCUMENTCODE"],
    "email": "example@auco.ai",
    "message": "Cancelación por error en cláusula II..."
}'

Python

import requests
import json

url = "https://api.auco.ai/v1.5/ext/document/cancel"

payload = json.dumps({
  "codes": [
    "DOCUMENTCODE"
  ],
  "email": "example@auco.ai",
  "message": "Cancelación por error en cláusula II..."
})
headers = {
  'Authorization': 'prk_private_key_company',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Node.js

const axios = require('axios');
let data = JSON.stringify({
  codes: ['DOCUMENTCODE'],
  email: 'example@auco.ai',
  message: 'Cancelación por error en cláusula II...',
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.auco.ai/v1.5/ext/document/cancel',
  headers: {
    Authorization: 'prk_private_key_company',
    'Content-Type': 'application/json',
  },
  data: data,
};

axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

---

Exemples de réponse

Annuler un document

{
  "success": 1,
  "errors": {
    "cant": 0
  }
}

Annuler plusieurs documents

{
  "success": 2,
  "errors": {
    "cant": 1,
    "documents": ["DOCUMENTCODE"]
  }
}

---

⚠️ Réponses d'erreur

Code	Description
400	Paramètres manquants, ou certaines validations ne respectent pas les conditions d'applicabilité
401	Authentification invalide ou manquante