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).
O processo de extração é assíncrono e consiste em dois passos principais:
- Enviar o documento para a fila de processamento.
- 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
- JavaScript
- Python
- PHP
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/documento.pdf" \
-F "type=58" \
-F "externalId=pedido-cliente-123"
const myHeaders = new Headers();
myHeaders.append("IDEXA-API-KEY", "sua_api_key");
const formdata = new FormData();
formdata.append("files", fileInput.files[0], "documento.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));
import requests
url = "URL_BASE/documents/upload"
payload = {'type': '58', 'externalId': 'pedido-123'}
files=[('files',('documento.pdf',open('/path/to/documento.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
$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/documento.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"
}
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.
{
"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": [
{
"registro": "AV-1-2739",
"tipo": "None",
"titulo": "RESERVA LEGAL",
"transmitente": "None",
"adquirente": "None",
"valor": "250.000,00",
"metragem": "None",
"vigencia": "03/05/2023",
"instituicao": "None",
"baixa": "None",
"emitente_devedor": "None"
}
],
"nirf_detalhes": {
"nome": "Renato Garcia",
"cpf": "82104387623",
"rg": "254578",
"filiacao": "JOANA SILVA E JOÃO SILVA"
}
},
"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.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| matricula | String | Matrícula | "2.739" |
| dataEmissao | String | Data de Emissão | "08/02/2024" |
| proprietario | String | Proprietário | "RONÍ PIVATTO E ELCIO FABRO" |
| origemTituloAquisitivo | String | Origem/Título Aquisitivo | "MATRÍCULA Nº 1291" |
| tipoImovel | String | Tipo de Imóvel | "SÍTIO RURAL" |
| cidadeImovel | String | Cidade do Imóvel | "MUCAJAÍ" |
| estadoImovel | String | Estado do Imóvel | "RR" |
| comarcaImovel | String | Comarca do Imóvel | "MUCAJAÍ" |
| areaTerreno | String | Área de Terreno | "103,0429 ha" |
| areaEdificada | String | Área Edificada | "None" |
| areaAmpliada | String | Área Ampliada | "None" |
| inscricaoMunicipal | String | Inscrição Municipal | "None" |
| incra | String | INCRA | "9500172113384" |
| nirf | String | NIRF | "None" |
| dadosRegistro[].registro | String | Registro | "AV-1-2739" |
| dadosRegistro[].tipo | String | Tipo | "None" |
| dadosRegistro[].titulo | String | Título | "RESERVA LEGAL" |
| dadosRegistro[].transmitente | String | Transmitente | "None" |
| dadosRegistro[].adquirente | String | Adiquirente | "None" |
| dadosRegistro[].valor | String | Valor | "250.000,00" |
| dadosRegistro[].metragem | String | Metragem | "None" |
| dadosRegistro[].vigencia | String | Vigência | "03/05/2023" |
| dadosRegistro[].instituicao | String | Instituição | "None" |
| dadosRegistro[].baixa | String | Baixa | "None" |
| dadosRegistro[].emitenteDevedor | String | Emitente devedor | "None" |
| nirfDetalhes.nome | String | Nome | "Renato Garcia" |
| nirfDetalhes.cpf | String | CPF | "82104387623" |
| nirfDetalhes.rg | String | RG | "254578" |
| nirfDetalhes.filiacao | String | Filiacao | "JOANA SILVA E JOÃO SILVA" |