Datasets disponíveis

curl --request GET \
  --url https://api.lazydata.com.br/v1/enrichment/datasets/{target} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.lazydata.com.br/v1/enrichment/datasets/{target}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lazydata.com.br/v1/enrichment/datasets/{target}', 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/datasets/{target}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lazydata.com.br/v1/enrichment/datasets/{target}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lazydata.com.br/v1/enrichment/datasets/{target}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "Datasets de enriquecimento retornados com sucesso.",
  "result": {
    "type": "pf",
    "currency": "BRL",
    "view": "simple",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false
      }
    ]
  }
}

{
  "code": 200,
  "message": "Datasets de enriquecimento retornados com sucesso.",
  "result": {
    "type": "pf",
    "currency": "BRL",
    "view": "complete",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false,
        "description": "Informações cadastrais consolidadas do CPF consultado.",
        "source": "database",
        "additional_fields": {},
        "struct_type": "object",
        "struct": {
          "name": {
            "type": "string",
            "description": "Nome da pessoa consultada."
          },
          "tax_id": {
            "type": "string",
            "description": "CPF consultado."
          }
        }
      }
    ]
  }
}

{
  "code": 400,
  "message": "Tipo de enriquecimento inválido."
}

{
  "code": 401,
  "message": "Credencial da API inválida."
}

{
  "code": 403,
  "message": "A funcionalidade de consulta não está habilitada para a conta atual."
}

GET

https://api.lazydata.com.br/

enrichment

datasets

{target}

Datasets disponíveis

curl --request GET \
  --url https://api.lazydata.com.br/v1/enrichment/datasets/{target} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.lazydata.com.br/v1/enrichment/datasets/{target}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lazydata.com.br/v1/enrichment/datasets/{target}', 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/datasets/{target}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lazydata.com.br/v1/enrichment/datasets/{target}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lazydata.com.br/v1/enrichment/datasets/{target}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "Datasets de enriquecimento retornados com sucesso.",
  "result": {
    "type": "pf",
    "currency": "BRL",
    "view": "simple",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false
      }
    ]
  }
}

{
  "code": 200,
  "message": "Datasets de enriquecimento retornados com sucesso.",
  "result": {
    "type": "pf",
    "currency": "BRL",
    "view": "complete",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false,
        "description": "Informações cadastrais consolidadas do CPF consultado.",
        "source": "database",
        "additional_fields": {},
        "struct_type": "object",
        "struct": {
          "name": {
            "type": "string",
            "description": "Nome da pessoa consultada."
          },
          "tax_id": {
            "type": "string",
            "description": "CPF consultado."
          }
        }
      }
    ]
  }
}

{
  "code": 400,
  "message": "Tipo de enriquecimento inválido."
}

{
  "code": 401,
  "message": "Credencial da API inválida."
}

{
  "code": 403,
  "message": "A funcionalidade de consulta não está habilitada para a conta atual."
}

Retorna os datasets disponíveis para uso em enriquecimentos de pessoa física ou pessoa jurídica. Use esta rota antes de iniciar o processamento para montar a seleção de datasets, estimar o custo por linha e identificar campos adicionais exigidos.

Esta listagem é específica para enriquecimento. Ela retorna apenas datasets ativos e habilitados para processamento em massa.

{
  "code": 200,
  "message": "Datasets de enriquecimento retornados com sucesso.",
  "result": {
    "type": "pf",
    "currency": "BRL",
    "view": "simple",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false
      }
    ]
  }
}

{
  "code": 200,
  "message": "Datasets de enriquecimento retornados com sucesso.",
  "result": {
    "type": "pf",
    "currency": "BRL",
    "view": "complete",
    "datasets": [
      {
        "id": "person_basic_data",
        "name": "Dados básicos",
        "price": 0.05,
        "active": true,
        "debit_only_if_found": false,
        "description": "Informações cadastrais consolidadas do CPF consultado.",
        "source": "database",
        "additional_fields": {},
        "struct_type": "object",
        "struct": {
          "name": {
            "type": "string",
            "description": "Nome da pessoa consultada."
          },
          "tax_id": {
            "type": "string",
            "description": "CPF consultado."
          }
        }
      }
    ]
  }
}

{
  "code": 400,
  "message": "Tipo de enriquecimento inválido."
}

{
  "code": 401,
  "message": "Credencial da API inválida."
}

{
  "code": 403,
  "message": "A funcionalidade de consulta não está habilitada para a conta atual."
}

Parâmetros

string

required

Tipo de enriquecimento usado para listar datasets disponíveis.

Valores aceitos para target:

Valor	Descrição
`pf`	Datasets de pessoa física para enriquecimento por CPF.
`person`	Alias de `pf`.
`pj`	Datasets de pessoa jurídica para enriquecimento por CNPJ.
`company`	Alias de `pj`.

string

default:"complete"

Formato da listagem retornada.

Valores aceitos para view:

Valor	Descrição
`simple`	Retorna apenas dados mínimos para seleção, custo e processamento.
`complete`	Retorna dados mínimos, descrição, origem, campos adicionais e estrutura de retorno.

Resposta

integer

required

Código da resposta da API.

string

required

Mensagem descritiva da resposta.

object

required

Objeto principal com o tipo de enriquecimento, moeda, visualização usada e datasets disponíveis.

Estrutura de `result`

Campo	Tipo	Descrição
`type`	`string`	Tipo do enriquecimento: `pf` ou `pj`.
`currency`	`string`	Moeda usada nos preços retornados. Atualmente `BRL`.
`view`	`string`	Visualização usada no retorno: `simple` ou `complete`.
`datasets`	`array<object>`	Lista de datasets disponíveis para enriquecimento.

Visualização simplificada

Use view=simple quando você precisa apenas montar a seleção de datasets ou calcular a estimativa de custo.

Estrutura de `result.datasets[]`

Campo	Tipo	Descrição
`id`	`string`	Identificador do dataset. Use este valor no campo `datasets` ao iniciar o enriquecimento.
`name`	`string`	Nome amigável exibido no painel ou na sua interface.
`price`	`number`	Preço por linha processada naquele dataset, já com regras comerciais aplicadas à conta autenticada.
`active`	`boolean`	Indica se o dataset está ativo. Nesta rota, os datasets retornados já são utilizáveis.
`debit_only_if_found`	`boolean`	Indica se a cobrança final do dataset ocorre apenas quando houver retorno útil.

Visualização completa

Use view=complete quando você precisa exibir descrição, campos adicionais ou estrutura esperada de retorno.

Estrutura de `result.datasets[]`

Campo	Tipo	Descrição
`id`	`string`	Identificador do dataset.
`name`	`string`	Nome amigável do dataset.
`price`	`number`	Preço por linha processada naquele dataset.
`active`	`boolean`	Indica se o dataset está ativo.
`debit_only_if_found`	`boolean`	Indica se pode haver estorno quando não houver retorno útil.
`description`	`string`	Descrição do dataset e do tipo de informação retornada.
`source`	`string`	Origem operacional do dataset.
`additional_fields`	`object`	Campos adicionais exigidos pelo dataset, quando houver.
`struct_type`	`string`	Tipo da estrutura de retorno esperada.
`struct`	`object`	Descrição dos campos que podem ser retornados pelo dataset.

Campos adicionais

Quando um dataset exigir parâmetros extras, eles aparecem em additional_fields. Exemplo:

{
  "additional_fields": {
    "state": {
      "type": "string",
      "label": "UF",
      "required": true,
      "description": "Sigla da unidade federativa usada no processamento."
    }
  }
}

Ao iniciar o enriquecimento, envie esses valores no campo additional, usando o ID do dataset como chave:

{
  "document_column": 0,
  "datasets": ["person_example_dataset"],
  "additional": {
    "person_example_dataset": {
      "state": "SP"
    }
  }
}

Estimativa de custo

O custo estimado do enriquecimento é calculado a partir da quantidade de linhas válidas e da soma dos preços dos datasets selecionados.

linhas válidas x soma dos preços dos datasets

Se um dataset tiver debit_only_if_found: true, a execução pode gerar estorno parcial ao final quando não houver retorno útil para determinadas linhas.

Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.

Status	Quando ocorre
`200`	Datasets retornados com sucesso.
`400`	O `target` ou `view` informado não é aceito.
`401`	A chave da API está ausente, inválida ou não pôde ser autenticada.
`403`	A credencial não possui escopo de enriquecimento, o plano não permite acesso ou há bloqueio financeiro.
`422`	Validação do parâmetro de rota ou query falhou no schema da API reference.

Como usar no fluxo

Crie o enriquecimento e envie o arquivo.
Aguarde o status waiting_configuration.
Liste os datasets disponíveis para o tipo do enriquecimento.
Escolha os IDs dos datasets retornados nesta rota.
Envie os IDs em Configurar e executar.

Datasets retornados em Datasets e preços podem não estar habilitados para enriquecimento. Para enriquecimento, use esta rota.

Documentação

Consultas

Validações

Monitoramento

Enriquecimento

Armazenamento

Upload de arquivos

Datasets disponíveis

Parâmetros

Resposta

Estrutura de `result`

Visualização simplificada

Estrutura de `result.datasets[]`

Visualização completa

Estrutura de `result.datasets[]`

Campos adicionais

Estimativa de custo

Respostas esperadas

Como usar no fluxo

​Parâmetros

​Resposta

​Estrutura de result

​Visualização simplificada

​Estrutura de result.datasets[]

​Visualização completa

​Estrutura de result.datasets[]

​Campos adicionais

​Estimativa de custo

​Respostas esperadas

​Como usar no fluxo

Parâmetros

Resposta

Estrutura de `result`

Visualização simplificada

Estrutura de `result.datasets[]`

Visualização completa

Estrutura de `result.datasets[]`

Campos adicionais

Estimativa de custo

Respostas esperadas

Como usar no fluxo