Cancelar o processo de assinatura

POST/document/cancelchave privadaprk_

Este serviço permite cancelar um ou mais documentos. Ele notifica os signatários de que o(s) documento(s) foi(ram) cancelado(s), com uma mensagem explicando o motivo do cancelamento.

info

Para cancelar um documento, ele não pode estar totalmente assinado nem ter sido rejeitado anteriormente.

dica

Esta ação também é notificada via WEBHOOK.

---

Autenticação

Inclua sua chave privada no cabeçalho Authorization.

Authorization: prk_xxx...

---

Parâmetros de criação

Nome	Tipo	Descrição
codes	Array obrigatório	Lista de códigos de documentos a cancelar, por exemplo: ['TR99AQMY31']
message	String obrigatório	Parâmetro que especifica a mensagem que justifica o cancelamento; essa mensagem é enviada aos signatários que foram notificados anteriormente ou que já assinaram.
email	String obrigatório	Este parâmetro é enviado quando é necessário manter um registro do usuário que cancela o documento.

---

🧪 Exemplos de uso

Cancelar um processo

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);
  });

---

Exemplos de resposta

Cancelar um documento

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

Cancelar vários documentos

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

---

⚠️ Respostas de erro

Código	Descrição
400	Parâmetros ausentes, ou algumas validações não atendem às condições de aplicabilidade
401	Autenticação inválida ou ausente