Procuração Privada e Pública
Modelo na Plataforma
Sigla: PROCURAÇÕES
Descrição: Procuração Privada e Pública
Modelo Via API
Type: 31
Este modelo extrai informações-chave de um Procuração Privada e Pública (PROCURAÇÕES).
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 31 para PRIVATE_AND_PUBLIC_PROXY. | 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=31" \
-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", "31");
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': '31', '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' => '31',
'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": 31,
"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": 31,
"data": {
"from": [
{
"name": "String",
"social_name": "String",
"trading_name": "String",
"type": "ENTITY/INDIVIDUAL",
"suid": "CPF/CNPJ",
"birth_date": "String",
"gender": "String",
"address": {
"street": "String",
"number": "String",
"sbn": "String",
"neighborhood": "String",
"city": "String",
"postal_code": "String",
"state": "String"
},
"phone": {
"country_code": "55",
"state_code": "24",
"number": "String"
}
}
],
"to": {
"name": "String",
"social_name": "String",
"trading_name": "String",
"type": "ENTITY/INDIVIDUAL",
"suid": "CPF/CNPJ",
"birth_date": "String",
"gender": "String",
"address": {
"street": "String",
"number": "String",
"sbn": "String",
"neighborhood": "String",
"city": "String",
"postal_code": "String",
"state": "String"
},
"phone": {
"country_code": "55",
"state_code": "24",
"number": "String"
}
},
"permissions": {
"permissions_granted": "String",
"grant_transfer": "PROHIBITED",
"expiration_date": "xx/xx/xxxx",
"description_expiration": "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: Procuração Privada e Pública
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| from[].name | String | Nome | "" |
| from[].socialName | String | Nome Social | "" |
| from[].tradingName | String | Nome Fantasia | "" |
| from[].type | String | Tipo | "ENTITY/INDIVIDUAL" |
| from[].suid | String | Identificação | "CPF/CNPJ" |
| from[].birthDate | String | Data de Nascimento | "" |
| from[].gender | String | Gênero | "" |
| from[].address.street | String | Rua | "" |
| from[].address.number | String | Número | "" |
| from[].address.sbn | String | Complemento | "" |
| from[].address.neighborhood | String | Bairro | "" |
| from[].address.city | String | Cidade | "" |
| from[].address.postalCode | String | CEP | "" |
| from[].address.state | String | Estado | "" |
| from[].phone.countryCode | String | Código do país | "55" |
| from[].phone.stateCode | String | DDD | "24" |
| from[].phone.number | String | Número | "" |
| to.name | String | Nome | "" |
| to.socialName | String | Nome Social | "" |
| to.tradingName | String | Nome Fantasia | "" |
| to.type | String | Tipo | "ENTITY/INDIVIDUAL" |
| to.suid | String | Identificação | "CPF/CNPJ" |
| to.birthDate | String | Data de Nascimento | "" |
| to.gender | String | Gênero | "" |
| to.address.street | String | Rua | "" |
| to.address.number | String | Número | "" |
| to.address.sbn | String | Complemento | "" |
| to.address.neighborhood | String | Bairro | "" |
| to.address.city | String | Cidade | "" |
| to.address.postalCode | String | CEP | "" |
| to.address.state | String | Estado | "" |
| to.phone.countryCode | String | Código do país | "55" |
| to.phone.stateCode | String | DDD | "24" |
| to.phone.number | String | Número | "" |
| permissions.permissionsGranted | String | Permissões Concedidas | "" |
| permissions.grantTransfer | String | Concede Transferência | "PROHIBITED" |
| permissions.expirationDate | String | Data de Validade | "xx/xx/xxxx" |
| permissions.descriptionExpiration | String | Descrição da Validade | "" |