🟠 Cancelar Proceso de Firma

POST /document/cancel

Con este servicio puedes cancelar uno o varios documentos. Este servicio notifica a los firmantes del documento que ha sido cancelado, con un mesaje explicando la cancelación de el o los documentos.

info

Para poder cancelar un documento este no debe estar firmado en su totalidad o no ser rechazado anteriormente.

tip

Esta acción es notificada también via WEBHOOK.

---

Autenticación

Incluye tu llave privada en el encabezado Authorization.

Authorization: prk_xxx...

---

Parámetros de creación

Nombre	Tipo	Requerido	Descripción
codes	Array	Requerido	Lista de códigos de documentos a cancelar ej: ['TR99AQMY31']
message	string	Rwquerido	Parámetro que determina el mensaje que justifica la cancelación, este mensaje se envía a los firmantes ya notificados previamente o que ya han firmado para firma.
email	string	Requerido	Este parámetro se envía cuando se requiera guardar registro del usuario que cancela el documento.

---

🧪 Ejemplos de uso

Cancelación de un proceso

curl

curl --location 'https://dev.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://dev.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://dev.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);
  });

---

Ejemplos de respuesta

cancelación de un documento

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

Cancelación de varios documentos

info

La URL firmada proporcionada en la respuesta es de un solo uso y estará disponible únicamente durante 5 segundos. Debe utilizarse para cargar el documento PDF en formato binario mediante una solicitud HTTP PUT.

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

---

⚠️ Respuestas de error

Código	Descripción
400	Faltan parámetros, o alguna de las validaciones no coinciden con las condiciones de aplicabilidad
401	Autenticación inválida o ausente