Matrícula de Imóveis

Modelo na Plataforma

Sigla: IMOB - MATRÍCULA IMÓVEIS

Descrição: Matrícula de Imóveis

Modelo Via API

Type: 58

Este modelo extrai informações-chave de um Matrícula de Imóveis (IMOB - MATRÍCULA IMÓVEIS), 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 58 para PROPERTY_REGISTRATION.	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=58" -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", "58");
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': '58', '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' => '58',
    '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": 58,
  "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": 58,
  "data": {
    "matricula": "2.739",
    "data_emissao": "08/02/2024",
    "proprietario": "RONÍ PIVATTO E ELCIO FABRO",
    "origem_titulo_aquisitivo": "MATRÍCULA Nº 1291",
    "tipo_imovel": "SÍTIO RURAL",
    "cidade_imovel": "MUCAJAÍ",
    "estado_imovel": "RR",
    "comarca_imovel": "MUCAJAÍ",
    "area_terreno": "103,0429 ha",
    "area_edificada": "None",
    "area_ampliada": "None",
    "inscricao_municipal": "None",
    "incra": "9500172113384",
    "nirf": "None",
    "dados_registro": "",
    "nirf_detalhes": "None"
  },
  "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: Matrícula de Imóveis

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

Campo	Tipo	Descrição
matricula	String	Matrícula
dataEmissao	String	Data de Emissão
proprietario	String	Proprietário
origemTituloAquisitivo	String	Origem/Título Aquisitivo
tipoImovel	String	Tipo de Imóvel
cidadeImovel	String	Cidade do Imóvel
estadoImovel	String	Estado do Imóvel
comarcaImovel	String	Comarca do Imóvel
areaTerreno	String	Área de Terreno
areaEdificada	String	Área Edificada
areaAmpliada	String	Área Ampliada
inscricaoMunicipal	String	Inscrição Municipal
incra	String	INCRA
nirf	String	NIRF
dadosRegistro	Array	Dados de Registro
nirfDetalhes	String	NIRF - Detalhes