Pular para o conteúdo principal

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:

  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 31 para PRIVATE_AND_PUBLIC_PROXY.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=31" \
-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": 31,
"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": 31,
"data": {
"to": [
{
"name": "MARIA DA SILVA EXEMPLO",
"suid": "123.456.789-09",
"type": "String",
"phone": {
"number": "99999-0000",
"state_code": "54",
"country_code": "55"
},
"gender": "String",
"address": {
"sbn": "Apto 201",
"city": "Cidade Exemplo",
"state": "RS",
"number": "100",
"street": "Rua das Flores",
"no_number": true,
"postal_code": "99999-000",
"address_type": "String",
"neighborhood": "Centro"
},
"birth_date": "1980-05-17",
"social_name": "String",
"trading_name": "LOJA EXEMPLO"
}
],
"from": [
{
"name": "MARIA DA SILVA EXEMPLO",
"suid": "123.456.789-09",
"type": "String",
"phone": {
"number": "99999-0000",
"state_code": "54",
"country_code": "55"
},
"gender": "String",
"address": {
"sbn": "Apto 201",
"city": "Cidade Exemplo",
"state": "RS",
"number": "100",
"street": "Rua das Flores",
"no_number": true,
"postal_code": "99999-000",
"address_type": "String",
"neighborhood": "Centro"
},
"birth_date": "1980-05-17",
"social_name": "String",
"trading_name": "LOJA EXEMPLO"
}
],
"permissions": {
"grant_transfer": "String",
"expiration_date": "2028-10-20",
"permissions_granted": [
"String"
],
"description_expiration": "VÁLIDA POR 2 (DOIS) ANOS A CONTAR DA ASSINATURA"
}
},
"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.

CampoTipoDescriçãoExemplo
to[].nameStringname"MARIA DA SILVA EXEMPLO"
to[].suidStringsuid"123.456.789-09"
to[].typeStringtype""
to[].phone.numberStringnumber"99999-0000"
to[].phone.stateCodeStringstate_code"54"
to[].phone.countryCodeStringcountry_code"55"
to[].genderStringgender""
to[].address.sbnStringsbn"Apto 201"
to[].address.cityStringcity"Cidade Exemplo"
to[].address.stateStringstate"RS"
to[].address.numberStringnumber"100"
to[].address.streetStringstreet"Rua das Flores"
to[].address.noNumberBooleanno_number""
to[].address.postalCodeStringpostal_code"99999-000"
to[].address.addressTypeStringaddress_type""
to[].address.neighborhoodStringneighborhood"Centro"
to[].birthDateStringbirth_date"1980-05-17"
to[].socialNameStringsocial_name""
to[].tradingNameStringtrading_name"LOJA EXEMPLO"
from[].nameStringname"MARIA DA SILVA EXEMPLO"
from[].suidStringsuid"123.456.789-09"
from[].typeStringtype""
from[].phone.numberStringnumber"99999-0000"
from[].phone.stateCodeStringstate_code"54"
from[].phone.countryCodeStringcountry_code"55"
from[].genderStringgender""
from[].address.sbnStringsbn"Apto 201"
from[].address.cityStringcity"Cidade Exemplo"
from[].address.stateStringstate"RS"
from[].address.numberStringnumber"100"
from[].address.streetStringstreet"Rua das Flores"
from[].address.noNumberBooleanno_number""
from[].address.postalCodeStringpostal_code"99999-000"
from[].address.addressTypeStringaddress_type""
from[].address.neighborhoodStringneighborhood"Centro"
from[].birthDateStringbirth_date"1980-05-17"
from[].socialNameStringsocial_name""
from[].tradingNameStringtrading_name"LOJA EXEMPLO"
permissions.grantTransferStringgrant_transfer""
permissions.expirationDateStringexpiration_date"2028-10-20"
permissions.permissionsGrantedArraypermissions_granted""
permissions.descriptionExpirationStringdescription_expiration"VÁLIDA POR 2 (DOIS) ANOS A CONTAR DA ASSINATURA"