Skip to main content

Informar Assinatura

Requisição

Endpoint

  • Metodo: PATCH
  • Endpoint: /v2/proposals/{proposalId}/signature

Parâmetros (Path)

ParâmetroTipoObrigatórioDescrição
proposalIdstring (uuid)Identificador da proposta

Parâmetros (Body)

ParâmetroTipoObrigatórioDescrição
signatureIdstringIdentificador da assinatura
signedAtstring (date-time)Data da assinatura
signatureProviderstringProvedor de assinatura
Exemplo de corpo
{
"signatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signedAt": "2025-08-10T02:07:49.030Z",
"signatureProvider": "clicksign"
}

Resposta

Campos da resposta (200)

ParâmetroTipoDescrição
messagestringMensagem de confirmação
policyIdstring (uuid)Identificador da apólice gerada
signature.signatureIdstring | nullIdentificador da assinatura
signature.signedAtstring (date-time) | nullData de assinatura
signature.signatureProviderstring | nullProvedor de assinatura
Exemplo (200)
{
"message": "Signature has been successfully saved.",
"policyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signature": {
"signatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signedAt": "2025-08-10T02:07:49.030Z",
"signatureProvider": "clicksign"
}
}

Erros

CódigoHTTPDescrição
NOT_FOUND404Proposta não encontrada.
ALREADY_SIGNED409Proposta já possui assinatura registrada.