Declaração Pessoal de Saúde - Seguro Habitacional - Apólice de Mercado

Modelo na Plataforma

Sigla: IMOB - DPS HDI

Descrição: Declaração Pessoal de Saúde - Seguro Habitacional - Apólice de Mercado

Modelo Via API

Type: 100

Este modelo extrai informações-chave de um Declaração Pessoal de Saúde - Seguro Habitacional - Apólice de Mercado (IMOB - DPS HDI), como dados do funcionário, da empresa, tipo de exame e aptidão para o trabalho.

O processo de extração é assíncrono e consiste em dois passos principais:

1. Enviar o documento para a fila de processamento.
2. Consultar o resultado após a conclusão do processamento.

Passo 1: Enviar o Documento para Processamento

Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.

POST URL Ambiente/documents/upload

Headers

Identificador	Valor
Content-Type	multipart/form-data
IDEXA-API-KEY	sua_api_key

Payload (Corpo da Requisição)

A requisição deve conter os seguintes parâmetros obrigatórios:

Parâmetro	Descriçao	Tipo
files	O arquivo do documento a ser processado.	File
type	Código interno do modelo. Use 100 para PERSONAL_HEALTH_DECLARATION.	Integer

Os parâmetros a seguir são opcionais:

Parâmetro	Descriçao	Tipo
pages	Define páginas específicas para análise (ex: "1,2,5-10").	String
externalId	Id externo para seu controle (não pode repetir).	String

Exemplos de Requisição

cURL

curl -X POST "URL_BASE/documents/upload" -H "IDEXA-API-KEY: sua_api_key" -H "Content-Type: multipart/form-data" -F "files=@/path/to/seu/atestado.pdf" -F "type=100" -F "externalId=pedido-cliente-123"

JavaScript

const myHeaders = new Headers();
myHeaders.append("IDEXA-API-KEY", "sua_api_key");

const formdata = new FormData();
formdata.append("files", fileInput.files[0], "atestado.pdf");
formdata.append("type", "100");
formdata.append("externalId", "pedido-cliente-123");

const requestOptions = { method: 'POST', headers: myHeaders, body: formdata };

fetch("URL_BASE/documents/upload", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result));

Python

import requests

url = "URL_BASE/documents/upload"
payload = {'type': '100', 'externalId': 'pedido-123'}
files=[('files',('atestado.pdf',open('/path/to/atestado.pdf','rb'),'application/pdf'))]
headers = {'IDEXA-API-KEY': 'sua_api_key'}

response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.json())

PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "URL_BASE/documents/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => [
    'files' => new CURLFile('/path/to/atestado.pdf'),
    'type' => '100',
    'externalId' => 'pedido-cliente-123'
  ],
  CURLOPT_HTTPHEADER => [
    "IDEXA-API-KEY: sua_api_key"
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Resposta Imediata (Status 200)

A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.

{
  "id": "95893394-337c-429c-a63e-1b8210de47d2",
  "externalId": "pedido-cliente-123",
  "type": 100,
  "status": 0,
  "statusDesc": "RECEIVED",
  "createdAt": "2026-01-07T14:38:50.045Z",
  "updatedAt": "2026-01-07T14:38:50.045Z"
}

Processamento Assíncrono

A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.

Passo 2: Consultar o Resultado

Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.

GET URL Ambiente/documents/[id]

Resposta Final (Status 200)

Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.

Exemplo de Resposta Completa

{
  "id": "95893394-337c-429c-a63e-1b8210de47d2",
  "externalId": "pedido-cliente-123",
  "type": 100,
  "data": {
    "document_title": "true",
    "social_name": "VANDERLEI TOSCANO",
    "civil_name": "VANDERLEI TOSCANO",
    "has_name": "true",
    "date_of_birth": "1972-12-28",
    "has_date_of_birth": "true",
    "occupation": "PASTOR",
    "has_occupation": "true",
    "questions": "",
    "city": "CAMPINAS",
    "state": "SP",
    "date": "2026-04-17",
    "has_city_state_and_date": "DE ACORDO",
    "signature": "true",
    "questions_order": "DE ACORDO",
    "inconformidades": "DE ACORDO"
  },
  "processTime": 8.123,
  "status": 1,
  "statusDesc": "FINISHED",
  "createdAt": "2026-01-07T14:38:50.045Z",
  "updatedAt": "2026-01-07T14:38:58.168Z"
}

Dicionário de Dados: Declaração Pessoal de Saúde - Seguro Habitacional - Apólice de Mercado

Estes são os campos retornados dentro do objeto data.

Campo	Tipo	Descrição
documentTitle	Boolean	Título do documento presente (HDI Seguros + título exato)
socialName	String	Nome Social do Proponente
civilName	String	Nome Civil do Proponente
hasName	Boolean	Indica se há ao menos um nome preenchido
dateOfBirth	String	Data de Nascimento do Proponente (YYYY-MM-DD)
hasDateOfBirth	Boolean	Indica se a data de nascimento está preenchida
occupation	String	Ocupação Principal do Proponente
hasOccupation	Boolean	Indica se a ocupação está preenchida
questions	Object	Respostas às questões do formulário DPS
city	String	Cidade da assinatura
state	String	Estado da assinatura (UF)
date	String	Data da assinatura (YYYY-MM-DD)
hasCityStateAndDate	String	Validação de local e data (DE ACORDO / FALTA CIDADE / FALTA ESTADO / FALTA DATA)
signature	Boolean	Indica se há assinatura do proponente
questionsOrder	String	Validação da ordem das perguntas (DE ACORDO / FALTAM PERGUNTAS / ORDEM INCORRETA)
inconformidades	String	Inconformidades consolidadas do documento (DE ACORDO se nenhuma)