Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Webhook

Testar mensagem webhook para assinatura

Permite testar o retorno e o recebimento de mensagem que é enviada pelo serviço após conclusão de uma assinatura.

post/api/service/sign/v1/webhook/test/signature

Request body

urlstring

Url para a qual o payload de exemplo será enviado. Caso vazio, método apenas irá retornar o valor de exemplo como resposta da requisição.

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

Método que será utilizado para enviar o payload de exemplo.

Example request

{
  "url": "http://minhaaplicacao.com.br:5670/receber/mensagem/webhook",
  "method": "POST"
}

Response

Retorno de uma assinatura para webhook

uuidstring

Request_id criado para o envio

Example response

{
  "uuid": "a0089a7c-3f15-48d2-995a-6f59ed79f824",
  "signer": {
    "signerNonce": "Signer Nonce",
    "signerUuid": "d23ef88b-d749-49c4-a8ac-58ca397a9927",
    "name": "João Qualificada",
    "signatureStatus": "Pending"
  },
  "documents": [
    {
      "documentNonce": "DocumentNonce",
      "documentUuid": "d23ef88b-d749-49c4-a8ac-58ca397a9927",
      "currentDocumentLink": {
        "href": "https://easysign.bry.com.br/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}/signed"
      },
      "originalDocumentLink": {
        "href": "https://easysign.bry.com.br/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}/file"
      }
    }
  ]
}