Skip to main content
O ambiente de teste permite validar integrações com a Lazy Data sem consumir saldo da conta. Para executar uma chamada em modo de teste, envie o header:
x-ambient: sandbox

Como habilitar

Inclua o header x-ambient: sandbox na requisição, junto com sua autenticação.
POST /v1/search/person
Authorization: Bearer SUA_CHAVE_DE_API
Content-Type: application/json
x-ambient: sandbox
Exemplo de corpo:
{
  "tax_id": "00000000000",
  "mode": "sync",
  "datasets": [
    "person_basic_data"
  ]
}

Produção

Para executar chamadas reais, não envie o header x-ambient: sandbox.
POST /v1/search/person
Authorization: Bearer SUA_CHAVE_DE_API
Content-Type: application/json
Chamadas em produção podem consumir saldo ou gerar cobrança, conforme os datasets e funcionalidades utilizados.

Funcionalidades com suporte a teste

Atualmente, o ambiente de teste está disponível para as seguintes funcionalidades:
FuncionalidadeSuporte
ConsultasSim
ValidaçõesSim
EnriquecimentosNão
MonitoramentosNão
ArmazenamentoNão

Consultas

As consultas podem ser executadas em ambiente de teste para validar payloads, autenticação e estrutura de retorno.
POST /v1/search/company
Authorization: Bearer SUA_CHAVE_DE_API
Content-Type: application/json
x-ambient: sandbox
{
  "tax_id": "00000000000000",
  "mode": "sync",
  "datasets": [
    "company_basic_data"
  ]
}

Validações

As validações também aceitam o header x-ambient: sandbox. Isso permite validar o envio dos dados e o formato da resposta sem cobrança real.
POST /v1/validation/face-match
Authorization: Bearer SUA_CHAVE_DE_API
x-ambient: sandbox
Mesmo em ambiente de teste, os dados enviados precisam respeitar as validações de formato, tamanho e obrigatoriedade.

Retorno

O ambiente de teste mantém o mesmo padrão de resposta da API.
{
  "code": 200,
  "message": "Operação realizada com sucesso.",
  "result": {}
}
O conteúdo de result pode ser simulado, controlado ou limitado, dependendo da funcionalidade e dos datasets utilizados.

Boas práticas

  • Use x-ambient: sandbox durante o desenvolvimento da integração.
  • Valide autenticação, payloads e tratamento de erros antes de ir para produção.
  • Não use respostas do ambiente de teste para decisões reais.
  • Remova o header x-ambient: sandbox ao executar chamadas em produção.