Skip to main content

Informar Assinatura

Requisição

Endpoint

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

Parâmetros (Path)

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

Parâmetros (Body)

ParâmetroTipoObrigatórioDescrição
signature_idstringIdentificador da assinatura
signed_atstring (date-time)Data da assinatura
signature_providerstringProvedor de assinatura
Exemplo de corpo
{
"signature_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signed_at": "2025-08-10T02:07:49.030Z",
"signature_provider": "clicksign"
}

Resposta

Campos da resposta (200)

ParâmetroTipoDescrição
messagestringMensagem de confirmação
policy_idstring (uuid)Identificador da apólice gerada
signature.signature_idstring | nullIdentificador da assinatura
signature.signed_atstring (date-time) | nullData de assinatura
signature.signature_providerstring | nullProvedor de assinatura
Exemplo (200)
{
"message": "Signature has been successfully saved.",
"policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signature": {
"signature_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signed_at": "2025-08-10T02:07:49.030Z",
"signature_provider": "clicksign"
}
}

Erros

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