Kipflow
  1. API de Consulta
Kipflow
  • API de Consulta
    • Ínicio
    • Empresas
      • Buscar Empresa por CNPJ ou Domínio
    • Pessoas
      • Buscar Pessoa por CPF
    • Esquemas
      • EnderecoDto
      • ContatoDto
      • AtividadeDto
      • SocioDto
      • CompanyDto
      • ApiErrorDto
      • CompanySearchResponseDto
      • InvalidCnpjResponseDto
      • CompanyNotFoundResponseDto
      • CreateCheckoutDto
      • ActivityListDto
      • CpfDataDto
      • CpfResponseDto
  1. API de Consulta

Ínicio

API de Consulta de Dados Empresariais#

Consulte dados cadastrais de empresas brasileiras (CNPJ) e informações de CPF de forma rápida, confiável e econômica.

Índice#

Autenticação
Endpoints
Pricing & Datasets
Rate Limits
Erros Comuns

Autenticação#

Todas as requisições à API requerem autenticação via API Key.

Como Autenticar#

Envie sua API Key no header X-API-Key em todas as requisições:

Gerenciamento de API Keys#

Criar: Acesse o dashboard → API Keys → Nova Chave
Revogar: Dashboard → API Keys → Ações → Revogar
Múltiplas Keys: Crie diferentes keys para ambientes (dev, prod) ou serviços

Segurança#

Importante:
Nunca exponha sua API Key em código cliente (frontend)
Use variáveis de ambiente: process.env.API_KEY
Revogue imediatamente keys comprometidas
Rotacione keys periodicamente

Endpoints#

Base URL#

https://api.kipflow.io
A API oferece os seguintes endpoints principais:
GET /companies/{cnpj} - Consulta dados de empresas por CNPJ
GET /cpf/{cpf} - Consulta informações de CPF

Pricing & Datasets#

Sistema de Cobrança#

A API utiliza um sistema de cobrança por dataset, permitindo que você pague apenas pelos dados que precisa.

Tabela de Preços#

DatasetPreçoCampos Inclusos
basicR$ 0,02CNPJ, razão social, nome fantasia, situação cadastral, natureza jurídica, CNAE principal
completeR$ 0,12Capital social, porte, faturamento, filiais, MEI, Simples, tributação, atividades secundárias
addressR$ 0,05Endereço completo, CEP, bairro, município, UF, lat/lon, macrorregião
emailsR$ 0,05Emails
phonesR$ 0,05Telefones
online_presenceR$ 0,05Sites, Facebook, Instagram, LinkedIn, tecnologias utilizadas
partnersR$ 0,05Lista de sócios, CPF (mascarado), qualificação, data de entrada, idade

Exemplos de Custo#

ConsultaDatasetsCusto Total
Dados básicos apenasbasicR$ 0,02
Empresa + Endereçobasic,addressR$ 0,07
Dados completos + Localizaçãobasic,complete,addressR$ 0,19
Todos os dadosbasic,complete,address,phones,emails,online_presence,partnersR$ 0,40

Como Funciona#

1.
Seleção: Escolha os datasets necessários via query parameter
2.
Cobrança: O valor é calculado automaticamente e debitado do saldo
3.
Resposta: A API retorna os campos solicitados + informações de custo
Exemplo:
Consultando múltiplos datasets:
GET /companies/35965725000107?datasets=basic,complete,address
Resposta:
{
  "success": true,
  "data": {
    /* dados dos datasets solicitados */
  },
  "datasets": ["basic", "complete", "address"],
  "cost": 0.19,
  "costFormatted": "R$ 0,19"
}

Gestão de Créditos#

Compra: Adquira créditos via dashboard com pagamento por Stripe
Saldo: Visualize seu saldo atual em tempo real
Histórico: Acompanhe todas as transações e consultas
Alertas: Receba notificações quando o saldo estiver baixo

Rate Limits#

Para garantir disponibilidade e performance para todos os usuários, a API implementa rate limiting por API Key.

Limites por API Key#

JanelaLimiteDescrição
Por segundo10 requisiçõesLimite de burst
Por minuto100 requisiçõesLimite médio
Por hora1.000 requisiçõesLimite de volume

Resposta de Rate Limit Excedido#

Quando você excede o limite, a API retorna 429 Too Many Requests:
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Limite de requisições excedido. Tente novamente em 5 segundos.",
    "limit": 10,
    "ttl": 1000
  }
}

Boas Práticas#

O que fazer ao receber erro 429:
1.
Aguarde o tempo indicado no campo ttl da resposta
2.
Implemente um sistema de retry com intervalo crescente
3.
Distribua suas requisições ao longo do tempo
4.
Use cache para dados consultados com frequência
5.
Evite loops rápidos sem delay entre requisições

Erros Comuns#

Códigos de Erro#

Código HTTPCódigo InternoDescriçãoSolução
401API_KEY_MISSINGAPI Key não foi enviadaAdicione o header X-API-Key
401API_KEY_INVALIDAPI Key inválida ou desativadaVerifique sua key no dashboard
429RATE_LIMIT_EXCEEDEDLimite de requisições excedidoAguarde e implemente retry com backoff
400INVALID_CNPJCNPJ inválido (formato ou dígito verificador)Valide o CNPJ antes de enviar
404COMPANY_NOT_FOUNDEmpresa não encontrada na base de dadosVerifique o CNPJ
402INSUFFICIENT_CREDITSSaldo insuficiente no workspaceAdicione créditos via dashboard
500INTERNAL_ERRORErro interno do servidorTente novamente ou entre em contato

Formato de Erro#

{
  "success": false,
  "error": {
    "code": "API_KEY_INVALID",
    "message": "API Key inválida ou desativada",
    "details": {}
  }
}

Como Tratar os Erros#

Sempre verifique o código de erro retornado e trate adequadamente:
401: Verifique sua API Key no dashboard
429: Aguarde o tempo indicado antes de nova tentativa
402: Adicione créditos ao seu workspace
400/404: Verifique os dados enviados na requisição
500: Tente novamente ou entre em contato com o suporte

Suporte#

Contato#

Email: suporte@driva.com.br
Website: https://driva.io
Modificado em 2026-01-09 16:11:42
Próxima página
Buscar Empresa por CNPJ ou Domínio
Built with