Cancelar documentos
Este endpoint permite cancelar/rechazar un documento en curso para interrumpir el proceso de firma
Observaciones
Permisos: Puede ser usado por administradores, propietarios o grupos con acceso.
Estado final: El documento queda con estado "rechazado" y no puede ser firmado nuevamente.
Marca de agua: Se añade la marca de agua "Documento rechazado" en el PDF final indicando la cancelación.
Webhook: Puede disparar el webhook "doc_signed" después de la cancelación (PDF actualizado).
Estado del documento: Debe estar "en curso" para poder ser cancelado.
User-Agent: Header obligatorio para evitar spam.
Endpoint
POST
https://api.zapsign.com.br/api/v1/refuse/
Headers
Authorization*
string
Token de API precedido del texto "Bearer".
Ejemplo: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
.
Request Body
doc_token*
string
Token del documento
rejected_reason*
string
Motivo de la cancelación del documento. Esta información estará disponible en la plataforma web en los detalles del documento.
Ejemplo request
{
"doc_token": "bfe4e2c7-33be-4a70-8669-a0491f92e795",
"rejected_reason": "Documento cancelado por la empresa"
}
Response
{
"message": "Documento rechazado con éxito. Recuerde: este endpoint es asíncrono, por lo tanto, espere a que los PDF finales estén listos a través de webhooks o verifíquelos en unos minutos."
}
Códigos de error
400 missing_doc_token: Debe enviar el
doc_token
(string)400 missing_rejected_reason: Debe enviar el
rejected_reason
(string)400 invalid_json: El JSON enviado es inválido
403 document_already_signed: No se puede cancelar un documento ya firmado
403 document_already_refused: No se puede cancelar un documento que ya fue cancelado/rechazado
403 refuse_not_allowed: No está permitido rechazar este documento
404 document_not_found: Documento no encontrado
500 internal_error: Error interno al procesar la solicitud
Last updated
Was this helpful?