Skip to main content

Enviar Documento Comprobatório

Envia (ou substitui) um documento de escopo de apólice — provas reaproveitáveis entre sinistros, como documentação anti-fraude, que não precisam ser reenviadas a cada sinistro aberto contra a mesma apólice.

Requisição​

Endpoint​

  • Metodo: POST
  • Endpoint: /v2/policies/{policyId}/documents
  • Content-Type: application/json ou multipart/form-data

Parâmetros (Path)​

ParâmetroTipoObrigatórioDescrição
policyIdstring (uuid)✅Identificador da apólice

Parâmetros (Body)​

ParâmetroTipoObrigatórioDescrição
proofTypeNameTipo de Prova✅Tipo do documento — deve ser um tipo de escopo de apólice
urlstring❌*URL pública do arquivo. Exatamente um entre url/inlinePayload
inlinePayloadobject❌*Payload estruturado, quando aplicável
jobStartDatestring (date)❌Data de admissão no emprego — usado apenas em EMPLOYMENT_ADMISSION_PROOF
Exemplo de requisição
{
"proofTypeName": "ANTIFRAUD_DOCS",
"url": "https://docs.example.com/antifraude.pdf"
}
Exemplo de requisição — EMPLOYMENT_ADMISSION_PROOF
{
"proofTypeName": "EMPLOYMENT_ADMISSION_PROOF",
"url": "https://docs.example.com/admissao.pdf",
"jobStartDate": "2023-01-15"
}

Resposta​

Substituição automática

Um novo envio para o mesmo tipo de prova substitui automaticamente o documento anterior — não é necessário informar qual documento está sendo substituído. O documento anterior é preservado como histórico (marcado como substituído), apenas o mais recente é retornado nas consultas.

Campos da resposta (201)​

ParâmetroTipoDescrição
idstring (uuid)Identificador do documento
proofTypestringTipo do documento
originalUrlstring | nullURL original informada, quando enviada por URL
contentTypestring | nullContent-Type do arquivo armazenado
hasInlinePayloadbooleantrue quando o documento foi enviado como payload estruturado
jobStartDatestring (date) | nullData de admissão informada — presente apenas em EMPLOYMENT_ADMISSION_PROOF
createdAtstring (date-time)Data de envio
supersededAtstring (date-time) | nullData em que este documento foi substituído — null se ainda for o vigente
Exemplo (201)
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa2",
"proofType": "ANTIFRAUD_DOCS",
"originalUrl": "https://docs.example.com/antifraude.pdf",
"contentType": "application/pdf",
"hasInlinePayload": false,
"jobStartDate": null,
"createdAt": "2026-01-16T10:00:00.000Z",
"supersededAt": null
}

Contrato assinado (fallback)​

proofTypeName: "SIGNED_CONTRACT" envia o contrato assinado (CCB) de uma apólice cuja proposta foi assinada sem ContractFile — o caminho preferencial é enviar o arquivo em Informar Assinatura. Os dois caminhos usam o mesmo fluxo: mesma validação (PDF legível que referencia o CPF e o creditContractId da proposta), mesmos erros (INVALID_CONTRACT_FILE, CONTRACT_MISMATCH) e o mesmo registro, de modo que signature.contractOnFile passa a ser true.

  • Exige url ou file; inlinePayload retorna INVALID_PROOF_SOURCE.
  • Reenviar substitui o contrato anterior (o anterior fica com supersededAt preenchido).

Erros​

CódigoHTTPDescrição
NOT_FOUND404Apólice não encontrada.
INVALID_PROOF_TYPE422Tipo de prova inexistente.
CLAIM_PROOF_WRONG_ENDPOINT422O tipo de prova informado é de escopo de sinistro, não de apólice.
INVALID_PROOF_SOURCE422Deve ser informado exatamente um entre url, file ou inlinePayload.
DOCUMENT_DOWNLOAD_FAILED422Falha ao baixar o arquivo a partir da url informada.
INVALID_CONTRACT_FILE422SIGNED_CONTRACT: o arquivo não é um PDF válido/legível.
CONTRACT_MISMATCH422SIGNED_CONTRACT: o PDF não referencia o CPF ou o creditContractId da proposta.