Informar Assinatura
Requisição
Endpoint
- Metodo: PATCH
- Endpoint:
/v2/proposals/{proposalId}/signature
Parâmetros (Path)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| proposalId | string (uuid) | ✅ | Identificador da proposta |
Parâmetros (Body)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| signatureId | string | ✅ | Identificador da assinatura |
| signedAt | string (date-time) | ✅ | Data da assinatura |
| signatureProvider | string | ✅ | Provedor 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âmetro | Tipo | Descrição |
|---|---|---|
| message | string | Mensagem de confirmação |
| policyId | string (uuid) | Identificador da apólice gerada |
| signature.signatureId | string | null | Identificador da assinatura |
| signature.signedAt | string (date-time) | null | Data de assinatura |
| signature.signatureProvider | string | null | Provedor 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ódigo | HTTP | Descrição |
|---|---|---|
NOT_FOUND | 404 | Proposta não encontrada. |
ALREADY_SIGNED | 409 | Proposta já possui assinatura registrada. |