Datasets e preços
curl --request GET \
--url https://api.lazydata.com.br/v1/search/datasets/{target} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.lazydata.com.br/v1/search/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/search/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/search/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/search/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))
}HttpResponse<String> response = Unirest.get("https://api.lazydata.com.br/v1/search/datasets/{target}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lazydata.com.br/v1/search/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 retornados com sucesso.",
"result": {
"target": "person",
"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 retornados com sucesso.",
"result": {
"target": "person",
"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."
},
"birth_date": {
"type": "date",
"description": "Data de nascimento."
},
"tax_id": {
"type": "string",
"description": "CPF consultado."
}
},
"time": 1.2
}
]
}
}
{
"code": 400,
"message": "Tipo de consulta inválido."
}
{
"code": 401,
"message": "Credencial da API inválida."
}
{
"code": 403,
"message": "A credencial da API não possui permissão para este recurso."
}
Consultas
Datasets e preços
Liste os datasets disponíveis, preços aplicados e, quando necessário, a estrutura completa de retorno.
GET
https://api.lazydata.com.br/
/
v1
/
search
/
datasets
/
{target}
Datasets e preços
curl --request GET \
--url https://api.lazydata.com.br/v1/search/datasets/{target} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.lazydata.com.br/v1/search/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/search/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/search/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/search/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))
}HttpResponse<String> response = Unirest.get("https://api.lazydata.com.br/v1/search/datasets/{target}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lazydata.com.br/v1/search/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 retornados com sucesso.",
"result": {
"target": "person",
"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 retornados com sucesso.",
"result": {
"target": "person",
"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."
},
"birth_date": {
"type": "date",
"description": "Data de nascimento."
},
"tax_id": {
"type": "string",
"description": "CPF consultado."
}
},
"time": 1.2
}
]
}
}
{
"code": 400,
"message": "Tipo de consulta inválido."
}
{
"code": 401,
"message": "Credencial da API inválida."
}
{
"code": 403,
"message": "A credencial da API não possui permissão para este recurso."
}
Retorna os datasets disponíveis para um tipo de consulta, já considerando o preço final aplicado para a conta autenticada.
Use este endpoint para montar seletores de datasets, calcular estimativas de custo e entender quais campos cada dataset pode retornar.
Por padrão, a API retorna a visualização completa. Para respostas menores, use
Valores aceitos para
Valores aceitos para
Estrutura de
Estrutura de
Estrutura de
Quando houver campos adicionais, a estrutura indica o tipo, rótulo e obrigatoriedade:
Campos comuns em
Campos comuns dentro de
view=simple.
{
"code": 200,
"message": "Datasets retornados com sucesso.",
"result": {
"target": "person",
"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 retornados com sucesso.",
"result": {
"target": "person",
"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."
},
"birth_date": {
"type": "date",
"description": "Data de nascimento."
},
"tax_id": {
"type": "string",
"description": "CPF consultado."
}
},
"time": 1.2
}
]
}
}
{
"code": 400,
"message": "Tipo de consulta inválido."
}
{
"code": 401,
"message": "Credencial da API inválida."
}
{
"code": 403,
"message": "A credencial da API não possui permissão para este recurso."
}
Parâmetros
string
required
Tipo de consulta usado para listar os datasets disponíveis.
target:
| Valor | Descrição |
|---|---|
person | Datasets de pessoa física. |
pf | Alias de person. |
company | Datasets de pessoa jurídica. |
pj | Alias de company. |
process | Datasets processuais. |
vehicle | Datasets veiculares. |
string
default:"complete"
Formato da listagem retornada.
view:
| Valor | Descrição |
|---|---|
simple | Retorna apenas dados mínimos para listagem e cálculo de estimativa. |
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 consulta, moeda, visualização usada e lista de datasets disponíveis.
Estrutura de result
| Campo | Tipo | Descrição |
|---|---|---|
target | string | Tipo de consulta informado na rota. |
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 o tipo de consulta. |
Visualização simplificada
Useview=simple quando você só precisa montar uma lista de seleção ou calcular a estimativa da consulta.
GET /v1/search/datasets/person
Query: view=simple
Estrutura de result.datasets[]
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador do dataset. Use este valor no campo datasets das consultas. |
name | string | Nome amigável exibido no painel ou na sua interface. |
price | number | Preço final da consulta daquele dataset, já com regras comerciais aplicadas à conta autenticada. |
active | boolean | Indica se o dataset está disponível para uso. Datasets inativos não devem ser enviados em consultas. |
debit_only_if_found | boolean | Indica se a cobrança deve ocorrer apenas quando houver retorno útil. |
Visualização completa
Useview=complete quando você precisa exibir a descrição do dataset, campos adicionais exigidos ou a estrutura de retorno esperada.
GET /v1/search/datasets/person
Query: view=complete
Estrutura de result.datasets[]
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador do dataset. Use este valor no campo datasets das consultas. |
name | string | Nome amigável exibido no painel ou na sua interface. |
price | number | Preço final da consulta daquele dataset, já com regras comerciais aplicadas à conta autenticada. |
active | boolean | Indica se o dataset está disponível para uso. |
debit_only_if_found | boolean | Indica se a cobrança deve ocorrer apenas quando houver retorno útil. |
description | string | Descrição do dataset e do tipo de informação retornada. |
source | string | Origem operacional do dataset, como database ou online. |
additional_fields | object | Campos adicionais exigidos pelo dataset, quando houver. |
struct_type | string | Tipo da estrutura de retorno esperada, como object, array ou outro formato definido pelo dataset. |
struct | object | Descrição dos campos que podem ser retornados pelo dataset. |
time | number | Tempo estimado de execução em segundos, quando disponível. |
Campos descritos em
struct podem não ser retornados em todas as consultas. Alguns retornos dependem da disponibilidade da fonte, do documento consultado e das regras específicas de cada dataset.Campos adicionais
O campoadditional_fields aparece apenas na visualização completa e informa parâmetros extras que devem ser enviados no objeto additional durante uma consulta.
Quando estiver vazio, o dataset não exige dados adicionais:
{
"additional_fields": {}
}
{
"additional_fields": {
"state": {
"type": "string",
"label": "UF",
"required": true,
"description": "Sigla da unidade federativa usada na consulta."
}
}
}
additional_fields:
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Tipo esperado do valor. |
label | string | Nome amigável para exibição em interface. |
required | boolean | Indica se o campo é obrigatório. |
description | string | Explicação sobre o valor esperado. |
Estrutura de retorno do dataset
O campostruct aparece apenas na visualização completa e descreve os dados que podem ser retornados por cada dataset.
Exemplo:
{
"struct": {
"name": {
"type": "string",
"description": "Nome da pessoa consultada."
},
"birth_date": {
"type": "date",
"description": "Data de nascimento."
},
"tax_id": {
"type": "string",
"description": "CPF consultado."
}
}
}
struct:
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Tipo esperado do campo retornado. |
description | string | Descrição do campo. |
label | string | Nome amigável, quando disponível. |
items | object | Estrutura de itens, quando o campo for uma lista. |
properties | object | Subcampos, quando o campo for um objeto composto. |
Respostas esperadas
As respostas possíveis estão exemplificadas no painel lateral da página.| Status | Quando ocorre |
|---|---|
200 | A listagem foi retornada com sucesso. |
400 | O target ou o 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 consulta ou o plano da conta não permite acesso ao recurso. |
422 | Validação do parâmetro de rota ou query falhou no schema da API reference. |
Como usar o retorno
- Liste os datasets do tipo desejado usando
target. - Use
view=simplepara montar listas e estimativas com resposta menor. - Use
view=completequando precisar dedescription,additional_fieldsoustruct. - Exiba apenas datasets com
active: true. - Use
pricepara calcular a estimativa da consulta. - Use
idno campodatasetsdas requisições de consulta. - Se
additional_fieldstiver campos obrigatórios, colete esses dados antes de executar a consulta.
Exemplo de uso em uma consulta
Após obter o datasetperson_basic_data, envie o ID no campo datasets de uma consulta compatível:
{
"taxid": "00000000000",
"mode": "async",
"datasets": ["person_basic_data"],
"additional": {}
}
O CPF acima é fictício e serve apenas para demonstrar a estrutura da requisição. Em consultas reais ou testes sandbox, informe documentos válidos conforme o ambiente utilizado.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Tipo de consulta usado para listar os datasets disponíveis.
Query Parameters
Formato da listagem retornada.

