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

Aceita dois formatos de corpo: application/json (formato original, sem arquivo) ou multipart/form-data (para enviar o arquivo do contrato assinado junto com os demais campos).

Parâmetros (Body — application/json)​

ParâmetroTipoObrigatórioDescrição
signatureIdstring✅Identificador da assinatura
signedAtstring (date-time)✅Data da assinatura
signatureProviderstring✅Provedor de assinatura

Parâmetros (Body — multipart/form-data)​

ParâmetroTipoObrigatórioDescrição
SignatureIdstring✅Identificador da assinatura
SignedAtstring (date-time)✅Data da assinatura
SignatureProviderstring✅Provedor de assinatura
ContractFilefile⚠️ Opcional¹Arquivo do contrato assinado (PDF)

¹ ContractFile é opcional por enquanto, mas se tornará obrigatório em uma versão futura. Enquanto isso, use application/json para o fluxo sem arquivo, ou multipart/form-data para enviar o contrato junto com a assinatura.

Quando enviado, o arquivo passa por uma validação de sanidade: precisa ser um PDF legível cujo texto referencie o CPF e o identificador de contrato (creditContractId) desta proposta. Isso não comprova autenticidade da assinatura — apenas rejeita arquivos claramente errados ou corrompidos.

O contrato enviado aqui é o caminho preferencial e fica registrado na apólice como um documento do tipo SIGNED_CONTRACT, visível em Listar documentos da apólice. Para propostas assinadas sem arquivo (por exemplo, propostas antigas), o contrato pode ser enviado depois pelo fallback em Enviar documento.

Exemplo de corpo (JSON)
{
"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
signature.contractOnFilebooleanIndica se o contrato assinado foi enviado
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",
"contractOnFile": true
}
}

Erros​

CódigoHTTPDescrição
NOT_FOUND404Proposta não encontrada.
ALREADY_SIGNED409Proposta já possui assinatura registrada.
INVALID_CONTRACT_FILE422ContractFile não é um PDF válido/legível.
CONTRACT_MISMATCH422O conteúdo do PDF não referencia o CPF ou o creditContractId desta proposta.