Skip to content
/
Listar layouts de enrique...

Data Stone API (1.0)

A API da Data Stone fornece acesso a dados enriquecidos de pessoas físicas e jurídicas do Brasil.

Funcionalidades principais:

  • Consulta de informações de pessoas e empresas
  • Prospecção e busca avançada com filtros personalizados
  • Enriquecimento de dados B2B em lote
  • Dados auxiliares (CNAE, CBO, geolocalização)
  • Validação de contatos WhatsApp

Autenticação: Todas as requisições requerem uma API Key no header Authorization.

Base URL: https://api.datastone.com.br/v1

Webhooks

Sistema de notificação automática via POST ao final de processos de enriquecimento ou prospecção.

  • Cadastro: Via perfil do administrador com teste automático de disponibilidade da URL
  • Método: POST (enviado pela API para o cliente)
  • Retry Policy: 3 tentativas com intervalo de 1 minuto entre cada
  • Timeout: 30 segundos por requisição
  • Resposta requerida: HTTP 200 imediato

Payload do Webhook:

{
  "job_id": 123,
  "job_type": "enrichment",
  "status": "done"
}

Valores possíveis para job_type: enrichment, prospecting

Valores possíveis para status: requested, done, error

Rate Limiting

Limite Padrão: 100 requisições por dia (compartilhado entre API e painel)

  • Personalização: Limites podem ser customizados por conta/empresa
  • Whitelist de IPs: Administradores podem adicionar IPs que ficam isentos do rate limit
  • Resposta quando excedido: Status Code 429 Too Many Requests com bloqueio de 24 horas

Limite de Produto

Controle de uso por tipo de produto (gerenciado por administradores):

  • B2C (Consulta, Enriquecimento, Prospecção): 100.000 requisições/mês
  • B2B (Prospecção B2B, Consulta B2B): 50.000 requisições/mês

Resposta quando excedido: Status Code 429 Too Many Requests até início do próximo período

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server
https://docs.datastone.com.br/_mock/api/
Servidor de Produção
https://api.datastone.com.br/v1/

Consulta

Operações de consulta direta para pessoas físicas (CPF), empresas (CNPJ), validação de WhatsApp e verificação de saldo.

Operations

Prospecção B2B

Operações de prospecção e enriquecimento B2B para pessoas e empresas, incluindo filtros avançados, busca com autocomplete e enriquecimento em lote.

Operations

Enriquecimento

Operações de enriquecimento de dados em lote com layouts personalizáveis e processamento assíncrono.

Operations

Listar layouts de enriquecimento

Request

Retorna lista de layouts disponíveis para o processo de enriquecimento. Permite visualizar opções de formatação ao criar requisições.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.datastone.com.br/_mock/api/enrichment/layouts \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Layouts retornados com sucesso

Bodyapplication/jsonArray [
idinteger
Example: 3
namestring
Example: "Standard - Email PF"
descriptionstring
Example: "Layout padrão com emails de pessoa física"
requires_parametersboolean
Example: true
]
Response
application/json
[
  {
    "id": 3,
    "name": "Standard - Email PF",
    "description": "Layout padrão com emails de pessoa física",
    "requires_parameters": true
  }
]

Solicitar enriquecimento

Request

Cria uma requisição de enriquecimento de dados com layout específico.

Campo parameters: Alguns layouts exigem configuração adicional.

Exemplo - Layout 3 (Standard - Email PF):

  • Define quantos emails por pessoa serão retornados
  • Limite máximo: 5 emails por pessoa
  • Formato: Array JSON, ex: ["2"] para 2 emails

Múltiplos Parâmetros: Devem ser enviados como array ordenado, ex: ["1", "1"]

Security
ApiKeyAuth
Bodyapplication/jsonrequired
namestring

Nome identificador do job de enriquecimento

Example: "Enriquecimento Base Clientes Janeiro"
layout_idintegerrequired

ID do layout a ser utilizado

Example: 3
parametersArray of strings

Parâmetros adicionais exigidos pelo layout

Example: ["2"]
filestring(byte)required

Arquivo em base64 contendo CPF/CNPJ para enriquecer

Example: "UEsDBBQABgAIAAAAIQ..."
callback_emailstring(email)

Email para notificação quando processamento concluir

Example: "usuario@empresa.com"
curl -i -X POST \
  https://docs.datastone.com.br/_mock/api/enrichment \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Enriquecimento Base Clientes Janeiro",
    "layout_id": 3,
    "parameters": [
      "2"
    ],
    "file": "UEsDBBQABgAIAAAAIQ...",
    "callback_email": "usuario@empresa.com"
  }'

Responses

Enriquecimento solicitado com sucesso

Bodyapplication/json
idinteger

ID da requisição de enriquecimento

Example: 98765
statusstring
Example: "requested"
Response
application/json
{
  "id": 98765,
  "status": "requested"
}

Obter resultado do enriquecimento

Request

Recupera o resultado de uma requisição de enriquecimento.

Se webhook foi configurado, o status do processo será enviado automaticamente.

Security
ApiKeyAuth
Path
idintegerrequired

ID da requisição de enriquecimento

Example: 98765
curl -i -X GET \
  https://docs.datastone.com.br/_mock/api/enrichment/98765/result \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Resultado retornado com sucesso

Bodyapplication/json
idinteger
Example: 98765
statusstring
Enum"requested""done""error"
Example: "done"
resultobject

Dados enriquecidos

Response
application/json
{
  "id": 98765,
  "status": "done",
  "result": {}
}

Prospecção

Operações de prospecção com filtros geográficos e profissionais, incluindo contagem e geração de jobs de prospecção.

Operations

Auxiliares

Dados auxiliares como CNAE, CBO, geolocalização (estados, cidades, bairros) e setores empresariais.

Operations