Documentação

Documentação de sinistro

Quando um sinistro é aberto, a resposta inclui um objeto documentacao com o pedido vigente (documentos-pendentes) e os arquivos cujo upload já foi concluído (documentos-recebidos). O campo status do sinistro diz em que etapa esse pedido está.

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-pendentesPedido vigente da seguradora: documentos da abertura e, depois, um novo pedido feito durante a análise. O envio de arquivos não remove itens desta lista.
documentos-recebidosArquivos cujo upload já foi concluído, agrupados por tipo. Cada entrada contém tipo, titulo e a lista de arquivos.

O mesmo tipo pode aparecer nas duas listas ao mesmo tempo. Use documentos-recebidos para saber o que já chegou e status para saber se o sinistro ainda aguarda envio ou já está em análise.

Como os campos se relacionam

flowchart TD
  Abertura[Abertura do sinistro] --> Pendente[pendente-de-documentacao]
  Pendente --> Upload[enviar-documento + PUT]
  Upload --> Recebidos[documentos-recebidos]
  Recebidos --> Fulfilled{Todos os pendentes satisfeitos?}
  Fulfilled -->|Não| Pendente
  Fulfilled -->|Sim| Analise[documentacao-em-analise]
  Analise -->|Regulação aprova a documentação| Regulacao[em-regulacao]
  Regulacao -->|Lista de pendências esvaziada| Vazio[documentos-pendentes vazio]
  Analise -->|Regulação pede documento| Pendente
  Regulacao -->|Regulação pede documento| Pendente


documentos-pendentes

Representa o pedido vigente de documentação. Na abertura, a lista traz os documentos exigidos para a cobertura e a natureza informadas. Um pedido posterior da seguradora substitui a lista inteira: os tipos anteriores saem e entram só os do novo pedido, cada um com nova data-solicitacao.

O envio de um documento não o tira da lista de arquivos pendentes. A lista fica vazia quando a seguradora aprova a documentação e o status passa a em-regulacao.

Um item do pedido vigente conta como satisfeito — e isso muda o status, conforme a seção abaixo — quando existe um arquivo em documentos-recebidos com:

  1. O mesmo tipo do item pendente
  2. Upload concluído
  3. Envio concluído depois da data-solicitacao daquele item

Arquivo enviado antes da data-solicitacao vigente não satisfaz o pedido. Se a seguradora solicitar de novo um tipo que já foi enviado, é preciso enviar outro arquivo depois da nova data.

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 este pedido passou a exigir o documento
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".

O arquivo entra aqui depois que o PUT na url-envio é concluído, esteja o tipo em documentos-pendentes ou não. Enviar um tipo que não está no pedido vigente não altera documentos-pendentes nem, sozinho, o status.

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.

Status ligados à documentação

O glossário completo de status está em Primeiros passos. As transições abaixo são as que a documentação provoca. As demais (pagamento, recusa, conclusão) não alteram documentos-pendentes.

DeParaQuandodocumentos-pendentes
—pendente-de-documentacaoSinistro abertoLista inicial da cobertura e da natureza
pendente-de-documentacaopendente-de-documentacaoUpload concluído, mas ainda falta satisfazer algum item do pedido vigenteInalterada; o arquivo aparece em documentos-recebidos
pendente-de-documentacaodocumentacao-em-analiseTodo item do pedido vigente está satisfeitoInalterada
documentacao-em-analiseem-regulacaoSeguradora aprova a documentaçãoLista vazia
pendente-de-documentacaopendente-de-documentacaoSeguradora substitui o pedido vigenteSubstituída pelo novo pedido
documentacao-em-analise ou em-regulacaopendente-de-documentacaoSeguradora solicita documentosSubstituída pelo novo pedido

Enquanto o sinistro está em documentacao-em-analise, novos uploads continuam em documentos-recebidos e não mudam o status.

Webhooks correspondentes (detalhes em Webhooks de sinistro):

Eventostatus depois do evento
sinistro-documentacao-em-analisedocumentacao-em-analise
sinistro-documentacao-aprovadaem-regulacao
sinistro-documentacao-negadapendente-de-documentacao

sinistro-documentacao-negada significa que a seguradora pediu documentos de novo. Consulte documentos-pendentes para ver o pedido novo.

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êndio—identificacao-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. Outros tipos aceitos pelo produto podem ser enviados a qualquer momento; eles aparecem em documentos-recebidos. Eles só entram em documentos-pendentes se a seguradora os solicitar.

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 item do pedido)
  • Informe id-externo (opcional — identificador do seu sistema)
  1. Faça PUT do arquivo na url-envio retornada
  2. Consulte o sinistro novamente:
  • o arquivo deve aparecer em documentos-recebidos
  • o tipo permanece em documentos-pendentes
  • quando todos os itens do pedido vigente estão satisfeitos, status passa a documentacao-em-analise

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.

Exemplos


Sinistro recém-aberto

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

Depois do envio da CNH, o tipo permanece em documentos-pendentes e também aparece em documentos-recebidos. O status vai para análise.

{
  "status": "documentacao-em-analise",
  "documentacao": {
    "documentos-pendentes": [
      {"tipo": "cnh", "titulo": "CNH", "data-solicitacao": "2026-03-02T10:00:00Z"}
    ],
    "documentos-recebidos": [
      {
        "tipo": "cnh",
        "titulo": "CNH",
        "arquivos": [
          {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "nome-arquivo": "cnh.png",
            "data-envio": "2026-03-02T10:10:00Z",
            "tipo-documento": "cnh"
          }
        ]
      }
    ]
  }
}

Documentação aprovada

{
  "status": "em-regulacao",
  "documentacao": {
    "documentos-pendentes": [],
    "documentos-recebidos": [
      {
        "tipo": "cnh",
        "titulo": "CNH",
        "arquivos": [
          {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "nome-arquivo": "cnh.png",
            "data-envio": "2026-03-02T10:10:00Z",
            "tipo-documento": "cnh"
          }
        ]
      }
    ]
  }
}

Novo pedido da seguradora

O pedido anterior é substituído. Arquivos já recebidos permanecem em documentos-recebidos. O arquivo antigo da CNH não satisfaz este pedido, porque a data-envio é anterior à nova data-solicitacao.

{
  "status": "pendente-de-documentacao",
  "documentacao": {
    "documentos-pendentes": [
      {
        "tipo": "cnh",
        "titulo": "CNH",
        "data-solicitacao": "2026-03-10T14:00:00Z",
        "detalhe": "Arquivo ilegível"
      }
    ],
    "documentos-recebidos": [
      {
        "tipo": "cnh",
        "titulo": "CNH",
        "arquivos": [
          {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "nome-arquivo": "cnh.png",
            "data-envio": "2026-03-02T10:10:00Z",
            "tipo-documento": "cnh"
          }
        ]
      }
    ]
  }
}