Documentação

Documentação de sinistro

Quando um sinistro é aberto, a resposta inclui um objeto documentacao descrevendo quais documentos ainda estão pendentes e quais arquivos já foram recebidos.

Estrutura do objeto documentacao

{
  "documentacao": {
    "documentos-pendentes": [
      {
        "tipo": "cnh",
        "titulo": "CNH",
        "data-solicitacao": "2026-03-02T10:00:00Z"
      }
    ],
    "documentos-recebidos": [
      {
        "tipo": "cpf-cnpj",
        "titulo": "CPF",
        "arquivos": [
          {
            "id": "ccefa863-ef66-4f09-8191-130697c2d754",
            "nome-arquivo": "cpf.png",
            "data-envio": "2026-03-02T10:00:00Z",
            "tipo-documento": "cpf-cnpj",
            "id-externo": "external-id"
          }
        ]
      }
    ]
  }
}

Campos e significado

Campo (Sagas)Significado
documentos-pendentesDocumentos que ainda precisam ser enviados. Inclui solicitações iniciais e pedidos adicionais feitos durante a regulação.
documentos-recebidosDocumentos cujo envio já foi concluído, agrupados por tipo. Cada entrada contém tipo, titulo e a lista de arquivos.

Como os campos se relacionam

flowchart TD
  Abertura[Abertura do sinistro] --> Pendentes[documentos-pendentes]
  Pendentes --> Upload[enviar-documento + PUT]
  Upload --> Recebidos[documentos-recebidos]
  Recebidos --> Fulfilled{Todos pendentes satisfeitos?}
  Fulfilled -->|Sim| Analise["Documentação em análise"]
  Fulfilled -->|Não| Pendentes
  Regulacao[Regulação solicita doc adicional] --> Pendentes

documentos-pendentes

Representa o que ainda falta enviar. Um documento deixa de ser pendente quando:

  1. Um arquivo do cliente (source: client) é enviado com o tipo correspondente
  2. O upload foi concluído (status: uploaded)
  3. O arquivo foi enviado após a data-solicitacao da pendência

Documentos adicionais solicitados pela regulação (após análise ou negação parcial) também aparecem aqui, com nova data-solicitacao.

Campos de cada pendência:

CampoDescrição
tipoIdentificador do tipo de documento (ex.: cnh, certidao-obito)
tituloDescrição legível do documento exigido
data-solicitacaoQuando o documento passou a ser exigido
detalhe(opcional) Instrução adicional da regulação

documentos-recebidos

Visão agrupada por tipo de documento — útil para exibir na UI "CPF: 1 arquivo enviado", "CNH: pendente".

Cada arquivo dentro de arquivos inclui:

CampoDescrição
idIdentificador do arquivo (usado em Baixar documento)
nome-arquivoNome original do arquivo enviado
data-envioData/hora do envio
tipo-documentoTipo do documento associado
id-externo(opcional) Identificador externo informado no upload

Tipos internos (documento-interno, nao-aplicavel) são filtrados da API pública.

Documentos exigidos por cobertura

Os tipos variam por cobertura e natureza. Exemplos comuns:

CoberturaNaturezaDocumentos típicos
Mortemorte-acidental / morte-naturalcertidao-obito, identificacao-pessoal, cpf-cnpj
Perda de rendadesemprego / invalideztrct, ctps-digital, relatorio-medico-incapacidade
Incêndioidentificacao-pessoal, comprovante-residencia, fotos-danos, dois-orcamentos

A lista de pendências na abertura reflete a configuração do produto para a cobertura e natureza informadas.

Fluxo de envio

  1. Consulte documentos-pendentes no sinistro
  2. Para cada pendência, chame Enviar documento:
    • Informe nome-arquivo e data-envio (obrigatórios)
    • Informe tipo (recomendado — associa o arquivo ao documento pendente)
    • Informe id-externo (opcional — identificador do seu sistema)
  3. Faça PUT do arquivo na url-envio retornada
  4. Consulte o sinistro novamente — verifique se o tipo saiu de documentos-pendentes e aparece em documentos-recebidos

Tipos de documento (referência)

Tipos públicos aceitos incluem, entre outros:

cpf-cnpj, cnh, certidao-obito, identificacao-pessoal, comprovante-residencia, fotos-danos, dois-orcamentos, trct, relatorio-medico-incapacidade, laudo-medico-atendimento, nf-celular, bo-evento-ilicito

A lista completa de tipos públicos aceitos está documentada na referência de tipos de documento da Sagas API.

Exemplo: sinistro recém-aberto

Após abrir um sinistro de morte acidental, a resposta típica inclui:

{
  "numero-sinistro": "S123456789",
  "status": "pendente-de-documentacao",
  "documentacao": {
    "documentos-recebidos": [],
    "documentos-pendentes": [
      {"tipo": "cnh", "titulo": "CNH", "data-solicitacao": "2026-03-02T10:00:00Z"}
    ]
  }
}

Após enviar o CPF:

{
  "documentacao": {
    "documentos-pendentes": [
      {"tipo": "cnh", "titulo": "CNH", "data-solicitacao": "2026-03-02T10:00:00Z"}
    ],
    "documentos-recebidos": [
      {
        "tipo": "cpf-cnpj",
        "titulo": "CPF",
        "arquivos": [
          {
            "id": "ccefa863-ef66-4f09-8191-130697c2d754",
            "nome-arquivo": "cpf.png",
            "data-envio": "2026-03-02T10:00:00Z",
            "tipo-documento": "cpf-cnpj"
          }
        ]
      }
    ]
  }
}