Cancelar um Documento (API)

🚧 Importante: Não esqueça de enviar sua cryptKey na sua requisição.

Exemplo: https://secure.d4sign.com.br/api/v1/documents/{UUID-DOCUMENT}/cancel?cryptKey={SEU-CRYPT-KEY}

Este endpoint vai cancelar um documento e movê-lo para a fase "Cancelado".

POST /documents/{UUID-DOCUMENT}/cancel

Parâmetros da Requisição (URL)

Parâmetro	Descrição
`UUID-DOCUMENT`	(obrigatório) É o UUID do documento que você quer cancelar.

Header

JSON

{
    "Content-Type": "application/json",
    "tokenAPI": "{token-user}"
}

Body

Parâmetro	Descrição
`comment`	(opcional) Coloque aqui um comentário sobre o motivo do cancelamento.

JSON

{
	"comment": "comentário sobre o cancelamento"
}

Resposta de Confirmação

Se a requisição for bem-sucedida, você receberá uma confirmação de que a mensagem foi enviada.

JSON

{
    "message": "Message sent"
}

Exemplo de Resposta do Documento Cancelado

Ao listar o documento após o cancelamento (usando o endpoint de "Listar um Documento Específico"), você verá o status atualizado:

JSON

{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "6",
    "statusName": "Cancelado",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento"
}

Cancelar um Documento (API)

Esta seção da API D4Sign permite que você cancele um documento, mudando o status dele para "Cancelado". Isso é super útil se você precisar parar um processo de assinatura que não faz mais sentido.