Skip to main content
POST
https://localapi.lazydata.com.br
/
v1
/
enrichment
/
{enrichment_id}
/
start
Configurar e executar
curl --request POST \
  --url https://localapi.lazydata.com.br/v1/enrichment/{enrichment_id}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_column": 123,
  "datasets": [
    "<string>"
  ],
  "additional": {}
}
'
{
  "code": 202,
  "message": "Enriquecimento enviado para a fila.",
  "result": {
    "id": "9fcb573b-7f62-4774-978b-07e89dfef5f2",
    "type": "pf",
    "name": "Base de clientes",
    "status": "queued",
    "status_label": "Na fila",
    "resume_step": "progress",
    "configuration": {
      "document_column": 0,
      "document_column_name": "cpf",
      "datasets": ["person_basic_data"],
      "additional": {}
    },
    "cost": {
      "estimated": 6,
      "reserved": 6,
      "consumed": 0,
      "refunded": 0,
      "datasets": {
        "person_basic_data": {
          "id": "person_basic_data",
          "name": "Dados básicos",
          "price": 0.05,
          "debit_only_if_found": false
        }
      }
    },
    "progress": {
      "stage": "queued",
      "stage_label": "Enriquecimento na fila de processamento",
      "percent": 0,
      "total_rows": 120,
      "processed_rows": 0,
      "enriched_documents": 0,
      "invalid_documents": 0,
      "not_found_documents": 0,
      "failed_rows": 0
    }
  }
}
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. 
{
  "code": 202,
  "message": "Enriquecimento enviado para a fila.",
  "result": {
    "id": "9fcb573b-7f62-4774-978b-07e89dfef5f2",
    "type": "pf",
    "name": "Base de clientes",
    "status": "queued",
    "status_label": "Na fila",
    "resume_step": "progress",
    "configuration": {
      "document_column": 0,
      "document_column_name": "cpf",
      "datasets": ["person_basic_data"],
      "additional": {}
    },
    "cost": {
      "estimated": 6,
      "reserved": 6,
      "consumed": 0,
      "refunded": 0,
      "datasets": {
        "person_basic_data": {
          "id": "person_basic_data",
          "name": "Dados básicos",
          "price": 0.05,
          "debit_only_if_found": false
        }
      }
    },
    "progress": {
      "stage": "queued",
      "stage_label": "Enriquecimento na fila de processamento",
      "percent": 0,
      "total_rows": 120,
      "processed_rows": 0,
      "enriched_documents": 0,
      "invalid_documents": 0,
      "not_found_documents": 0,
      "failed_rows": 0
    }
  }
}

​
Parâmetros

​
enrichment_id
string
required
ID do enriquecimento.

​
Corpo da requisição

​
document_column
integer
required
Índice da coluna que contém CPF ou CNPJ no arquivo analisado.
​
datasets
string[]
required
Lista de IDs dos datasets que serão usados no enriquecimento.
​
additional
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

{
  "document_column": 0,
  "datasets": ["person_basic_data"],
  "additional": {}
}

​
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. 
{
  "analysis": {
    "columns": [
      {
        "index": 0,
        "name": "cpf",
        "sample": "00000000000"
      }
    ]
  }
}

​
Regras de cobrança

Ao iniciar, a API calcula: 
total de linhas válidas x soma dos preços dos datasets
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.