Skip to main content

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

CampoTipoDescriçãoExemplo
from[].nameStringNome""
from[].socialNameStringNome Social""
from[].tradingNameStringNome Fantasia""
from[].typeStringTipo"ENTITY/INDIVIDUAL"
from[].suidStringIdentificação"CPF/CNPJ"
from[].birthDateStringData de Nascimento""
from[].genderStringGênero""
from[].address.streetStringRua""
from[].address.numberStringNúmero""
from[].address.sbnStringComplemento""
from[].address.neighborhoodStringBairro""
from[].address.cityStringCidade""
from[].address.postalCodeStringCEP""
from[].address.stateStringEstado""
from[].phone.countryCodeStringCódigo do país"55"
from[].phone.stateCodeStringDDD"24"
from[].phone.numberStringNúmero""
to.nameStringNome""
to.socialNameStringNome Social""
to.tradingNameStringNome Fantasia""
to.typeStringTipo"ENTITY/INDIVIDUAL"
to.suidStringIdentificação"CPF/CNPJ"
to.birthDateStringData de Nascimento""
to.genderStringGênero""
to.address.streetStringRua""
to.address.numberStringNúmero""
to.address.sbnStringComplemento""
to.address.neighborhoodStringBairro""
to.address.cityStringCidade""
to.address.postalCodeStringCEP""
to.address.stateStringEstado""
to.phone.countryCodeStringCódigo do país"55"
to.phone.stateCodeStringDDD"24"
to.phone.numberStringNúmero""
permissions.permissionsGrantedStringPermissões Concedidas""
permissions.grantTransferStringConcede Transferência"PROHIBITED"
permissions.expirationDateStringData de Validade"xx/xx/xxxx"
permissions.descriptionExpirationStringDescrição da Validade""