Auxilio de Creche
Modelo na Plataforma
Sigla: DA
Descrição: Auxilio de Creche
Modelo Via API
Type: 61
Este modelo extrai informações-chave de um Auxilio de Creche (DA).
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 61 para Auxilio de creche. | 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=61" \
-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", "61");
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': '61', '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' => '61',
'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": 61,
"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": 61,
"data": {
"receipts": [
{
"fine": "10,00",
"payer": "FULANO DA SILVA",
"months": [
"01/2025"
],
"company": "EMPRESA A",
"student": "BELTRANO DA SILVA",
"amount_paid": "110,00",
"payment_date": "24/01/2024",
"daily_interest": "10,00",
"original_value": "100,00",
"expiration_date": "23/01/2024"
}
],
"bpm_number": "123456",
"employee_name": "Fulano da Silva"
},
"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: Auxilio de Creche
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| bpmNumber | String | bpm_number | "123456" |
| employeeName | String | employee_name | "Fulano da Silva" |
| receipts[].company | String | company | "EMPRESA A" |
| receipts[].payer | String | payer | "FULANO DA SILVA" |
| receipts[].employeeId | String | employee_id | "000.000.000-00" |
| receipts[].student | String | student | "BELTRANO DA SILVA" |
| receipts[].studentId | String | student_id | "000.000.000-00" |
| receipts[].expirationDate | String | expiration_date | "23/01/2024" |
| receipts[].originalValue | String | original_value | "100,00" |
| receipts[].paymentDate | String | payment_date | "24/01/2024" |
| receipts[].amountPaid | String | amount_paid | "110,00" |
| receipts[].fine | String | fine | "10,00" |
| receipts[].dailyInterest | String | daily_interest | "10,00" |
| receipts[].months | Array | months | ["01/2025"] |