Gestão de Imóveis
Modelo na Plataforma
Sigla: Imóveis
Descrição: Gestão de Imóveis
Modelo Via API
Type: 67
Este modelo extrai informações-chave de um Gestão de Imóveis (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 67 para PROPERTY_MANAGEMENT. | 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=67" \
-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", "67");
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': '67', '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' => '67',
'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": 67,
"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": 67,
"data": {
"document_type": "INSTRUMENTO PARTICULAR DE TRANSAÇÃO",
"grantors": [
{
"name": "String",
"type": "String",
"id": "String",
"street": "String",
"neighborhood": "String",
"city": "String",
"state": "String",
"spouse_name": "String"
}
],
"property": {
"registration": "String",
"registry_office": "String",
"street": "String",
"description": "String"
},
"undertaking_area": "String",
"banking_details": {
"bank": "String",
"agency": "String",
"account": "String",
"receiver_name": "String"
},
"compensation_value": "R$ 25.450,75",
"compensation_date": "2025-08-15",
"signature": "Boolean",
"signatures": [
{
"name": "String",
"position": "String"
}
]
},
"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: Gestão de Imóveis
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| documentType | String | Tipo do Documento | "INSTRUMENTO PARTICULAR DE TRANSAÇÃO" |
| grantors[].name | String | Nome Completo | "" |
| grantors[].type | String | Tipo de Pessoa (Física/Jurídica) | "" |
| grantors[].id | String | CPF ou CNPJ (apenas dígitos) | "" |
| grantors[].street | String | Endereço Completo | "" |
| grantors[].neighborhood | String | Bairro | "" |
| grantors[].city | String | Cidade | "" |
| grantors[].state | String | Estado (UF) | "" |
| grantors[].spouseName | String | Nome do Cônjuge | "" |
| property.registration | String | Matrícula do Imóvel | "" |
| property.registryOffice | String | Cartório de Registro | "" |
| property.street | String | Endereço do Imóvel | "" |
| property.description | String | Descrição detalhada | "" |
| undertakingArea | String | Área do Empreendimento | "" |
| bankingDetails.bank | String | Nome do Banco | "" |
| bankingDetails.agency | String | Agência | "" |
| bankingDetails.account | String | Conta Corrente | "" |
| bankingDetails.receiverName | String | Nome do Titular | "" |
| compensationValue | String | Valor da Indenização | "R$ 25.450,75" |
| compensationDate | String | Data da Indenização | "2025-08-15" |
| signature | Boolean | Presença de Assinatura | "" |
| signatures[].name | String | Nome do Assinante | "" |
| signatures[].position | String | Cargo | "" |