Reprovar documentos pelo usuário

POSThttps://api.zapsign.com.br/api/v1/refuse/by-user/

Descrição: Este endpoint permite reprovar um documento individual ou um envelope (conjunto de documentos em lote) enviando as informações necessárias no corpo da requisição.

Como Usar:

Envie um payload no formato JSON contendo os seguintes campos:

• doc_token: (string) Token do documento a ser reprovado.

• user_token: (string) Token do usuário que está reprovando o documento.

• signer_token: (string) Token do signatário relacionado ao documento.

• rejected_reason: (string, opcional) Motivo da recusa do documento.

Confira mais sobre os tipos de tokens aqui

Condições

• O documento deve estar com o status “Em andamento”.

• Ao criar o documento, o parâmetro allow_refuse_signature deve estar como true.

• O e-mail do signatário e do usuário deve ser o mesmo.

Observações:

• O sistema aplicará automaticamente a marca d'água padrão: "Documento recusado".

• A resposta do endpoint também será retornada no formato JSON.

• O documento deve estar com o status “Em curso”.

Headers

Name	Type	Description
Authorization*	string	Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
doc_token*	string	Token do documento
user_token*	string	Token do usuário
signer_token*	string	Token do signatário
rejected_reason	string	Motivo da recusa

Exemplo Request

{
    "doc_token":"e082d806-6b31-4e27-ae9a-e16b603a70b3",
    "user_token":"97ab0000-36d4-xxxx-9ded-00005d690xxxx",
    "signer_token": "8be272d8-20a9-xx-899c-db4edbb846cd",
    "rejected_reason": ""
}

Response

200 sucesso

{
    "message": "Documento recusado com sucesso. Lembrete: este endpoint é assíncrono, então aguarde os PDF finais ficarem prontos via webhooks ou confira-os daqui alguns minutos."
}

403

{
    "error": "A reprovação deste documento não é permitida."
}

400

{
    "error": "O e-mail do signatário e do usuário são diferentes"
}