Pular para o conteúdo principal

Matricula de Imóveis

Modelo na Plataforma

Sigla: MATRICULA

Descrição: Matricula de Imóveis

Modelo Via API

Type: 33

Este modelo extrai informações-chave de um Matricula de Imóveis (MATRICULA).

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 33 para MATRICULA_IMOVEIS.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=33" \
-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": 33,
"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": 33,
"data": {
"matricula": "xxxxx",
"data_emissao": "dd/mm/yyyy",
"proprietario": "JOSÉ DA SILVA",
"origem_titulo_aquisitivo": "",
"tipo_imovel": "LOTE RURAL",
"dados_registro": [
{
"registro": "R-1",
"titulo": "",
"valor": "xx.xxx,xx",
"vigencia": "dd/mm/yyyy",
"instituicao": "",
"tipo": "",
"baixa": "",
"emitente_devedor": ""
}
]
},
"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: Matricula de Imóveis​

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

CampoTipoDescriçãoExemplo
matriculaStringMatricula"xxxxx"
dataEmissaoStringData de Emissão"dd/mm/yyyy"
proprietarioStringProprietário"JOSÉ DA SILVA"
origemTituloAquisitivoStringOrigem do título aquisitivo""
tipoImovelStringTipo do imóvel"LOTE RURAL"
dadosRegistro[].registroStringRegistro"R-1"
dadosRegistro[].tituloStringTitulo""
dadosRegistro[].valorStringValor"xx.xxx,xx"
dadosRegistro[].vigenciaStringVigência"dd/mm/yyyy"
dadosRegistro[].instituicaoStringInstituicao""
dadosRegistro[].tipoStringTipo""
dadosRegistro[].baixaStringBaixa""
dadosRegistro[].emitenteDevedorStringEmitente devedor""