Skip to main content
POST
Configurar e executar
Configura e inicia o processamento de um enriquecimento. Esta rota deve ser chamada após o upload e análise do arquivo, quando o enriquecimento estiver em waiting_configuration.

Parâmetros

string
required
ID do enriquecimento.

Corpo da requisição

integer
required
Índice da coluna que contém CPF ou CNPJ no arquivo analisado.
string[]
required
Lista de IDs dos datasets que serão usados no enriquecimento.
object
Dados adicionais por dataset, quando algum dataset exigir campos extras.
Liste os datasets habilitados em Datasets disponíveis antes de iniciar o enriquecimento. Não use a listagem geral de consultas para decidir datasets de enriquecimento.

Exemplo de corpo

Como escolher document_column

Use a resposta de Consultar status após a análise do arquivo. O campo analysis.columns[] retorna colunas com index, name e amostras. Envie em document_column o index da coluna que contém CPF ou CNPJ.

Regras de cobrança

Ao iniciar, a API calcula:
O valor estimado é reservado antes da execução. Ao final, podem existir estornos conforme resultado e regra debit_only_if_found de cada dataset.

Próximo passo

Consultar status

Acompanhe a fila, progresso, consumo, estornos e arquivos de saída.