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/jsonoumultipart/form-data
Parâmetros (Path)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| policyId | string (uuid) | ✅ | Identificador da apólice |
Parâmetros (Body)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| proofTypeName | Tipo de Prova | ✅ | Tipo do documento — deve ser um tipo de escopo de apólice |
| url | string | ❌* | URL pública do arquivo. Exatamente um entre url/inlinePayload |
| inlinePayload | object | ❌* | Payload estruturado, quando aplicável |
| jobStartDate | string (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âmetro | Tipo | Descrição |
|---|---|---|
| id | string (uuid) | Identificador do documento |
| proofType | string | Tipo do documento |
| originalUrl | string | null | URL original informada, quando enviada por URL |
| contentType | string | null | Content-Type do arquivo armazenado |
| hasInlinePayload | boolean | true quando o documento foi enviado como payload estruturado |
| jobStartDate | string (date) | null | Data de admissão informada — presente apenas em EMPLOYMENT_ADMISSION_PROOF |
| createdAt | string (date-time) | Data de envio |
| supersededAt | string (date-time) | null | Data 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
}
Erros
| Código | HTTP | Descrição |
|---|---|---|
NOT_FOUND | 404 | Apólice não encontrada. |
INVALID_PROOF_TYPE | 422 | Tipo de prova inexistente. |
CLAIM_PROOF_WRONG_ENDPOINT | 422 | O tipo de prova informado é de escopo de sinistro, não de apólice. |
INVALID_PROOF_SOURCE | 422 | Deve ser informado exatamente um entre url, file ou inlinePayload. |
DOCUMENT_DOWNLOAD_FAILED | 422 | Falha ao baixar o arquivo a partir da url informada. |