Configurar e executar
curl --request POST \
--url https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_column": 123,
"datasets": [
"<string>"
],
"additional": {}
}
'import requests
url = "https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start"
payload = {
"document_column": 123,
"datasets": ["<string>"],
"additional": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_column: 123, datasets: ['<string>'], additional: {}})
};
fetch('https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_column' => 123,
'datasets' => [
'<string>'
],
'additional' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start"
payload := strings.NewReader("{\n \"document_column\": 123,\n \"datasets\": [\n \"<string>\"\n ],\n \"additional\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_column\": 123,\n \"datasets\": [\n \"<string>\"\n ],\n \"additional\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_column\": 123,\n \"datasets\": [\n \"<string>\"\n ],\n \"additional\": {}\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
}
{
"code": 400,
"message": "A coluna do documento selecionada não foi localizada no arquivo."
}
{
"code": 403,
"message": "A funcionalidade de consulta não está habilitada para a conta atual."
}
{
"code": 409,
"message": "Este enriquecimento não está disponível para iniciar."
}
Enriquecimento
Configurar e executar
Configure coluna de documento, datasets e campos adicionais para iniciar o enriquecimento.
POST
https://api.lazydata.com.br/
/
v1
/
enrichment
/
{enrichment_id}
/
start
Configurar e executar
curl --request POST \
--url https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_column": 123,
"datasets": [
"<string>"
],
"additional": {}
}
'import requests
url = "https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start"
payload = {
"document_column": 123,
"datasets": ["<string>"],
"additional": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_column: 123, datasets: ['<string>'], additional: {}})
};
fetch('https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_column' => 123,
'datasets' => [
'<string>'
],
'additional' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start"
payload := strings.NewReader("{\n \"document_column\": 123,\n \"datasets\": [\n \"<string>\"\n ],\n \"additional\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_column\": 123,\n \"datasets\": [\n \"<string>\"\n ],\n \"additional\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lazydata.com.br/v1/enrichment/{enrichment_id}/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_column\": 123,\n \"datasets\": [\n \"<string>\"\n ],\n \"additional\": {}\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
}
{
"code": 400,
"message": "A coluna do documento selecionada não foi localizada no arquivo."
}
{
"code": 403,
"message": "A funcionalidade de consulta não está habilitada para a conta atual."
}
{
"code": 409,
"message": "Este enriquecimento não está disponível para iniciar."
}
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
Como escolher
Use a resposta de Consultar status após a análise do arquivo.
O campo
O valor estimado é reservado antes da execução. Ao final, podem existir estornos conforme resultado e regra
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
}
}
}
{
"code": 400,
"message": "A coluna do documento selecionada não foi localizada no arquivo."
}
{
"code": 403,
"message": "A funcionalidade de consulta não está habilitada para a conta atual."
}
{
"code": 409,
"message": "Este enriquecimento não está disponível para iniciar."
}
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
{
"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
debit_only_if_found de cada dataset.
Próximo passo
Consultar status
Acompanhe a fila, progresso, consumo, estornos e arquivos de saída.
⌘I

