Resultado assíncrono
Consultas
Resultado assíncrono
Consulte o andamento e o resultado final de uma consulta assíncrona.
GET
Resultado assíncrono
Retorna o status atual e os dados disponíveis de uma consulta iniciada anteriormente em modo assíncrono.
Use este endpoint para implementar polling após receber o
Valores aceitos para
Estrutura de
Estrutura de
Estrutura de
Estrutura de
Cada chave representa um dataset solicitado.
Estrutura de
Estrutura de
O campo
Estrutura de
Objeto indexado pelo ID do dataset.
Estrutura de
Objeto indexado pelo ID do dataset. Cada chave contém o retorno final do dataset correspondente.
id de uma consulta com status queued ou processing.
Parâmetros
Tipo da consulta assíncrona que será detalhada.
target:
| Valor | Descrição |
|---|---|
person | Consulta de pessoa física. |
company | Consulta de pessoa jurídica. |
process | Consulta processual. |
vehicle | Consulta veicular. |
ID retornado ao iniciar a consulta assíncrona.
Resposta
Código da resposta da API.
Mensagem descritiva da resposta.
Objeto principal com o status, dados da consulta, custos, tempos, erros e retorno dos datasets.
Estrutura de result
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da consulta. |
status | string | Status atual da consulta. |
status_values | array<string> | Lista de status possíveis para consultas assíncronas. |
target | string | Tipo público da consulta: person, company, process ou vehicle. |
query | object | Dados usados para iniciar a consulta. |
cost | object | Valores cobrados e estornados. |
timing | object | Tempo total e tempo individual por dataset, quando disponível. |
errors | object | Erros por dataset, quando ocorrerem. |
cache | object | Informações de cache por dataset, quando aplicável. |
datasets_status | object | Status individual de cada dataset solicitado. |
result | object | Resultado agrupado por dataset. Pode ficar vazio enquanto a consulta estiver em andamento. |
created_at | string | Data de criação da consulta em ISO 8601. |
last_updated_at | string | Data da última atualização da consulta em ISO 8601. |
Status da consulta
| Status | Descrição |
|---|---|
queued | Consulta criada e aguardando processamento. |
processing | Consulta em processamento. |
completed | Consulta finalizada. Verifique errors para identificar falhas parciais por dataset. |
failed | Consulta finalizada com falha geral. |
Estrutura de query
| Campo | Tipo | Descrição |
|---|---|---|
taxid | string | CPF ou CNPJ consultado, quando a consulta usa documento. |
plate | string | Placa consultada, quando a consulta é veicular. |
datasets | array<string> | Datasets solicitados na consulta. |
additional | object | Campos adicionais enviados por dataset. |
Estrutura de cost
| Campo | Tipo | Descrição |
|---|---|---|
total | number | Valor total efetivamente debitado. |
refunded | number | Valor total estornado. |
datasets | object | Detalhamento financeiro por dataset. |
Estrutura de cost.datasets
Cada chave representa um dataset solicitado.
| Campo | Tipo | Descrição |
|---|---|---|
charged | number | Valor cobrado pelo dataset. |
refunded | number | Valor estornado para o dataset. |
Estrutura de timing
| Campo | Tipo | Descrição |
|---|---|---|
total | number | Tempo total da consulta em segundos, quando disponível. |
datasets | object | Tempo individual por dataset em segundos. |
Estrutura de errors
O campo errors retorna um objeto indexado pelo ID do dataset quando alguma base falha.
Estrutura de datasets_status
Objeto indexado pelo ID do dataset.
Estrutura de result.result
Objeto indexado pelo ID do dataset. Cada chave contém o retorno final do dataset correspondente.
Janela de leitura
O resultado assíncrono fica disponível para leitura por uma janela limitada após a criação da consulta. Atualmente, a janela de leitura é de aproximadamente 30 minutos. Após esse período, a API pode retornar404.
Polling recomendado
- Inicie a consulta em modo assíncrono.
- Guarde o
idretornado. - Consulte este endpoint usando o
targetcorrespondente. - Enquanto
statusforqueuedouprocessing, repita a consulta com intervalo progressivo. - Ao receber
completedoufailed, pare o polling e trateresult,errorsedatasets_status.
Evite polling agressivo. Para consultas com múltiplos datasets ou processos, use intervalos maiores para reduzir carga desnecessária.

