Skip to main content
GET
https://localapi.lazydata.com.br
/
v1
/
enrichment
/
datasets
/
{target}
Datasets disponíveis
curl --request GET \
  --url https://localapi.lazydata.com.br/v1/enrichment/datasets/{target} \
  --header 'Authorization: Bearer <token>'
{
  "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
      }
    ]
  }
}
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
      }
    ]
  }
}

​
Parâmetros

​
target
string
required
Tipo de enriquecimento usado para listar datasets disponíveis.
Valores aceitos para target:
ValorDescrição
pfDatasets de pessoa física para enriquecimento por CPF.
personAlias de pf.
pjDatasets de pessoa jurídica para enriquecimento por CNPJ.
companyAlias de pj.
​
view
string
default:"complete"
Formato da listagem retornada.
Valores aceitos para view:
ValorDescrição
simpleRetorna apenas dados mínimos para seleção, custo e processamento.
completeRetorna dados mínimos, descrição, origem, campos adicionais e estrutura de retorno.

​
Resposta

​
code
integer
required
Código da resposta da API.
​
message
string
required
Mensagem descritiva da resposta.
​
result
object
required
Objeto principal com o tipo de enriquecimento, moeda, visualização usada e datasets disponíveis.

​
Estrutura de result

CampoTipoDescrição
typestringTipo do enriquecimento: pf ou pj.
currencystringMoeda usada nos preços retornados. Atualmente BRL.
viewstringVisualização usada no retorno: simple ou complete.
datasetsarray<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[]

CampoTipoDescrição
idstringIdentificador do dataset. Use este valor no campo datasets ao iniciar o enriquecimento.
namestringNome amigável exibido no painel ou na sua interface.
pricenumberPreço por linha processada naquele dataset, já com regras comerciais aplicadas à conta autenticada.
activebooleanIndica se o dataset está ativo. Nesta rota, os datasets retornados já são utilizáveis.
debit_only_if_foundbooleanIndica 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[]

CampoTipoDescrição
idstringIdentificador do dataset.
namestringNome amigável do dataset.
pricenumberPreço por linha processada naquele dataset.
activebooleanIndica se o dataset está ativo.
debit_only_if_foundbooleanIndica se pode haver estorno quando não houver retorno útil.
descriptionstringDescrição do dataset e do tipo de informação retornada.
sourcestringOrigem operacional do dataset.
additional_fieldsobjectCampos adicionais exigidos pelo dataset, quando houver.
struct_typestringTipo da estrutura de retorno esperada.
structobjectDescriçã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.
StatusQuando ocorre
200Datasets retornados com sucesso.
400O target ou view informado não é aceito.
401A chave da API está ausente, inválida ou não pôde ser autenticada.
403A credencial não possui escopo de enriquecimento, o plano não permite acesso ou há bloqueio financeiro.
422Validação do parâmetro de rota ou query falhou no schema da API reference.

​
Como usar no fluxo

  1. Crie o enriquecimento e envie o arquivo.
  2. Aguarde o status waiting_configuration.
  3. Liste os datasets disponíveis para o tipo do enriquecimento.
  4. Escolha os IDs dos datasets retornados nesta rota.
  5. 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.