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": {
"pessoas": [
{
"cpf": "12345678909",
"nome": "JOÃO CARLOS DA SILVA"
}
],
"empresas": [
{
"cnpj": "11222333000181",
"razao_social": "CONSTRUTORA EXEMPLO LTDA"
}
],
"endereco": {
"bairro": "JARDIM EXEMPLO",
"numero": "250",
"logradouro": "RUA DAS ACÁCIAS",
"complemento": "LOTE 7 DA QUADRA B DO LOTEAMENTO JARDIM EXEMPLO"
},
"matricula": "12.345",
"tipo_imovel": "CASA URBANO",
"area_terreno": "360,00 M²",
"data_emissao": "15/10/2026",
"proprietario": "PEDRO HENRIQUE SOUZA E ANA PAULA SOUZA",
"area_ampliada": "String",
"cidade_imovel": "SANTA MARIA",
"estado_imovel": "RS",
"area_edificada": "142,50 M²",
"comarca_imovel": "SANTA MARIA",
"dados_registro": [
{
"tipo": "COMPRA E VENDA",
"baixa": "String",
"valor": "180000,00",
"titulo": "ESCRITURA PÚBLICA DE COMPRA E VENDA",
"registro": "R-1",
"vigencia": "10/03/2015",
"adquirente": "JOÃO CARLOS DA SILVA E MARIA APARECIDA DA SILVA",
"onus_ativo": "false",
"instituicao": "String",
"transmitente": "CONSTRUTORA EXEMPLO LTDA (CNPJ: 11.222.333/0001-81)",
"emitente_devedor": "String"
}
],
"imovel_foreiro": "false",
"historico_endereco": [
"String"
],
"inscricao_municipal": "10203040",
"ultimos_transmitentes": [
{
"nome": "JOÃO CARLOS DA SILVA",
"documento": "12345678909"
}
]
},
"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 |
|---|---|---|---|
| pessoas[].nome | String | nome | "JOÃO CARLOS DA SILVA" |
| pessoas[].cpf | String | cpf | "12345678909" |
| empresas[].razaoSocial | String | razao_social | "CONSTRUTORA EXEMPLO LTDA" |
| empresas[].cnpj | String | cnpj | "11222333000181" |
| endereco.bairro | String | bairro | "JARDIM EXEMPLO" |
| endereco.numero | String | numero | "250" |
| endereco.logradouro | String | logradouro | "RUA DAS ACÁCIAS" |
| endereco.complemento | String | complemento | "LOTE 7 DA QUADRA B DO LOTEAMENTO JARDIM EXEMPLO" |
| matricula | String | matricula | "12.345" |
| tipoImovel | String | tipo_imovel | "CASA URBANO" |
| areaTerreno | String | area_terreno | "360,00 M²" |
| dataEmissao | String | data_emissao | "15/10/2026" |
| proprietario | String | proprietario | "PEDRO HENRIQUE SOUZA E ANA PAULA SOUZA" |
| areaAmpliada | String | area_ampliada | "" |
| cidadeImovel | String | cidade_imovel | "SANTA MARIA" |
| estadoImovel | String | estado_imovel | "RS" |
| areaEdificada | String | area_edificada | "142,50 M²" |
| comarcaImovel | String | comarca_imovel | "SANTA MARIA" |
| dadosRegistro[].registro | String | registro | "R-1" |
| dadosRegistro[].tipo | String | tipo | "COMPRA E VENDA" |
| dadosRegistro[].titulo | String | titulo | "ESCRITURA PÚBLICA DE COMPRA E VENDA" |
| dadosRegistro[].transmitente | String | transmitente | "CONSTRUTORA EXEMPLO LTDA (CNPJ: 11.222.333/0001-81)" |
| dadosRegistro[].adquirente | String | adquirente | "JOÃO CARLOS DA SILVA E MARIA APARECIDA DA SILVA" |
| dadosRegistro[].emitenteDevedor | String | emitente_devedor | "" |
| dadosRegistro[].valor | String | valor | "180000,00" |
| dadosRegistro[].vigencia | String | vigencia | "10/03/2015" |
| dadosRegistro[].instituicao | String | instituicao | "" |
| dadosRegistro[].baixa | String | baixa | "" |
| dadosRegistro[].onusAtivo | Boolean | onus_ativo | "false" |
| imovelForeiro | Boolean | imovel_foreiro | "false" |
| historicoEndereco | Array | historico_endereco | "" |
| inscricaoMunicipal | String | inscricao_municipal | "10203040" |
| ultimosTransmitentes[].nome | String | nome | "JOÃO CARLOS DA SILVA" |
| ultimosTransmitentes[].documento | String | documento | "12345678909" |