🚫 Cancel Signing Process
POST /document/cancel
This service allows you to cancel one or more documents. It notifies the document signers that the document(s) have been canceled, with a message explaining the reason for the cancellation.
info
To cancel a document, it must not be fully signed or previously rejected.
tip
This action is also notified via WEBHOOK.
Authentication
Include your private key in the Authorization
header.
Authorization: prk_xxx...
Creation Parameters
Name | Type | Required | Description |
---|---|---|---|
codes | Array | Required | List of document codes to cancel e.g.: ['TR99AQMY31'] |
message | string | Required | Parameter that specifies the message justifying the cancellation; this message is sent to the signers who were previously notified or who have already signed. |
email | string | Required | This parameter is sent when it is necessary to keep a record of the user who cancels the document. |
🧪 Usage Examples
Canceling a process
- curl
- Python
- Node.js
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..."
}'
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)
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);
});
Response Examples
Canceling a document
{
"success": 1,
"errors": {
"cant": 0
}
}
Canceling multiple documents
{
"success": 2,
"errors": {
"cant": 1,
"documents": ["DOCUMENTCODE"]
}
}
⚠️ Error Responses
Code | Description |
---|---|
400 | Missing parameters, or some validations do not meet applicability conditions |
401 | Invalid or missing authentication |