Pular para o conteúdo principal

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:

  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​

IdentificadorValor
Content-Typemultipart/form-data
IDEXA-API-KEYsua_api_key

Payload (Corpo da Requisição)​

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

ParâmetroDescriçaoTipo
filesO arquivo do documento a ser processado.File
typeCódigo interno do modelo. Use 58 para PROPERTY_REGISTRATION.Integer

Os parâmetros a seguir são opcionais:

ParâmetroDescriçaoTipo
pagesDefine páginas específicas para análise (ex: "1,2,5-10").String
externalIdId externo para seu controle (não pode repetir).String

Exemplos de Requisição​

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"

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": [
{
"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.

CampoTipoDescriçãoExemplo
matriculaStringMatrícula"2.739"
dataEmissaoStringData de Emissão"08/02/2024"
proprietarioStringProprietário"RONÍ PIVATTO E ELCIO FABRO"
origemTituloAquisitivoStringOrigem/Título Aquisitivo"MATRÍCULA Nº 1291"
tipoImovelStringTipo de Imóvel"SÍTIO RURAL"
cidadeImovelStringCidade do Imóvel"MUCAJAÍ"
estadoImovelStringEstado do Imóvel"RR"
comarcaImovelStringComarca do Imóvel"MUCAJAÍ"
areaTerrenoStringÁrea de Terreno"103,0429 ha"
areaEdificadaStringÁrea Edificada"None"
areaAmpliadaStringÁrea Ampliada"None"
inscricaoMunicipalStringInscrição Municipal"None"
incraStringINCRA"9500172113384"
nirfStringNIRF"None"
dadosRegistro[].registroStringRegistro"AV-1-2739"
dadosRegistro[].tipoStringTipo"None"
dadosRegistro[].tituloStringTítulo"RESERVA LEGAL"
dadosRegistro[].transmitenteStringTransmitente"None"
dadosRegistro[].adquirenteStringAdiquirente"None"
dadosRegistro[].valorStringValor"250.000,00"
dadosRegistro[].metragemStringMetragem"None"
dadosRegistro[].vigenciaStringVigência"03/05/2023"
dadosRegistro[].instituicaoStringInstituição"None"
dadosRegistro[].baixaStringBaixa"None"
dadosRegistro[].emitenteDevedorStringEmitente devedor"None"
nirfDetalhes.nomeStringNome"Renato Garcia"
nirfDetalhes.cpfStringCPF"82104387623"
nirfDetalhes.rgStringRG"254578"
nirfDetalhes.filiacaoStringFiliacao"JOANA SILVA E JOÃO SILVA"