1. API de Consulta
Kipflow
  • API de Consulta
    • Ínicio
    • Empresas
      • Guia de Filtros da API - Consulta de Empresas
      • Buscar Empresa por CNPJ ou Domínio
      • Buscar Empresas com Filtros
    • Pessoas
      • Buscar Pessoa por CPF
    • Redes Sociais
      • Guia de Filtros da API - Consulta Social
      • Buscar Empresa no LinkedIn
      • Buscar Pessoa no LinkedIn
      • Buscar Pessoas no LinkedIn com Filtros
      • Buscar Personas no LinkedIn por Empresa
    • Contatos
      • Busca telefones de empresa por CNPJ ou domínio
      • Gerar emails de pessoas de uma empresa
      • Gerar email de uma pessoa a partir do LinkedIn ID
      • Gerar emails em lote a partir de IDs do LinkedIn
      • Gerar email a partir de nome completo + domínio
      • Gerar email a partir de nome completo + CNPJ
    • Inteligência
      • Classificar Atividade (CNAE) de Empresa
      • Buscar empresa por nome com score de similaridade
    • PER-DCOMP
      • Buscar declarações PER/DCOMP por CNPJ
    • Geolocalização
      • Buscar Lugares por CNPJ
    • Trabalhista
      • Consultar dados PAT por CNPJ
    • Veículos
      • Consultar frota de veículos por CNPJ
      • Consultar dados de um veículo por placa ou ID
      • Consultar tacógrafos vinculados a um CNPJ
      • Consultar dados de cronotacógrafo por placa
      • Consultar dados de múltiplos veículos por placas ou IDs
    • Jurídico
      • Buscar Parte por CPF
      • Buscar Parte por CNPJ
      • Buscar Parte por Raiz de CNPJ
      • Buscar Parte por Nome ou Razão Social
      • Buscar Parte por Nome ou Razão Social Exato
      • Buscar Advogado por CPF
      • Buscar Advogado por OAB
      • Buscar Advogado por Nome ou Razão Social
      • Buscar Advogado por Nome ou Razão Social Exato
    • Esquemas
      • EnderecoDto
      • AtividadeSecundariaDto
      • ContatoDto
      • SiteDto
      • AtividadeDto
      • SocialMediaDto
      • SocioDto
      • CompanyDto
      • TelefoneDto
      • ApiErrorDto
      • CompanySearchResponseDto
      • DividaItemDto
      • InvalidCnpjResponseDto
      • DividaDto
      • CompanyNotFoundResponseDto
      • CreateCheckoutDto
      • CompanyFilterRequestDto
      • ActivityListDto
      • CompanyFilterResponseDto
      • CpfDataDto
      • BalanceResponseDto
      • CpfResponseDto
      • PricingTierDto
      • BatchCnpjRequestDto
      • ApiErrorResponseDto
      • DatasetPricesDto
      • BatchItemResultDto
      • SocialCompanyDataDto
      • WorkspacePricingResponseDto
      • BatchSearchResponseDto
      • SocialSearchResponseDto
      • SetWorkspacePricingDto
      • BatchDomainRequestDto
      • InvalidSocialIdResponseDto
      • CurrentTierResponseDto
      • UpdateBillingInfoDto
      • SocialNotFoundResponseDto
      • BillingInfoDto
      • PersonEducationDto
      • CnpjLookupResultDto
      • PersonExperienceDto
      • PersonDataDto
      • PersonSearchResponseDto
      • InvalidPersonIdResponseDto
      • PersonNotFoundResponseDto
      • PeopleFilterRequestDto
      • PeopleFilterResponseDto
      • PhoneDto
      • ContactDataDto
      • ContactSearchResponseDto
      • ContactErrorResponseDto
      • AddCreditGrantRequestDto
      • PerdcompItemDto
      • PerdcompResponseDto
      • CpfBatchRequestDto
      • PerdcompNotFoundResponseDto
      • CpfBatchResponseDto
      • CpfLinkedinDataDto
      • EmailDto
      • GeneratedEmailDto
      • CpfLinkedinResponseDto
      • PerdcompDataDto
      • EmailDataDto
      • EmailSearchResponseDto
      • InvalidCnpjPerdcompResponseDto
      • PersonaSearchFilterDto
      • PersonaSearchRequestDto
      • CnaeAlternativoDto
      • ActivityClassifierDataDto
      • ActivityClassifierResponseDto
      • ActivityClassifierBadRequestResponseDto
      • ActivityClassifierNotFoundResponseDto
      • PatItemDto
      • PatResponseDto
      • InvalidCnpjPatResponseDto
      • EmailFilterDto
      • LinkedinBatchEmailRequestDto
      • PatNotFoundResponseDto
      • EmailFilterRequestDto
      • EmailGenerateByDomainRequestDto
      • EmailGenerateByCnpjRequestDto
      • VehicleTypeItemDto
      • PlateItemDto
      • FleetDataDto
      • FleetResponseDto
      • InvalidCnpjVehiclesResponseDto
      • VehiclesNotFoundResponseDto
      • PlateResponseDto
      • InvalidPlateResponseDto
      • GeoPlaceItemDto
      • GeoPlacesResponseDto
      • TachographRecordDto
      • TachographResponseDto
      • VehicleBatchRequestDto
      • ClasseProcessualDto
      • AssuntoCNJDto
      • OabAdvogadoDto
      • AdvogadoDto
      • ParteDto
      • ValorCausaDto
      • JulgamentoDto
      • StatusPredictusDto
      • ProcessoRelacionadoDto
      • LegalProcessoDto
      • PricingDto
      • LegalSearchResponseDto
      • LegalErrorResponseDto
  1. API de Consulta

Ínicio

API de Consulta de Dados Empresariais#

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

Índice#

Autenticação
Endpoints
Empresas (CNPJ)
Empresas (LinkedIn)
Pessoas (LinkedIn)
CPF
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:

Empresas (CNPJ)#

Consulta de dados cadastrais da Receita Federal.
GET /companies/v1/search - Consulta empresa por CNPJ ou domínio
POST /companies/v1/search - Busca avançada com filtros complexos

Empresas (LinkedIn)#

Consulta de dados de empresas no LinkedIn (R$ 0,49 por consulta).
GET /social/v1/companies/search - Busca empresa por ID público do LinkedIn

Pessoas (LinkedIn)#

Consulta de perfis profissionais no LinkedIn (R$ 0,49 por consulta/pessoa).
GET /social/v1/people/search - Busca pessoa por profile public ID
POST /social/v1/people/search - Busca avançada de pessoas com filtros

CPF#

Consulta de informações de CPF.
GET /cpf/v1/search - Consulta dados 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.

Como Funciona#

Para Endpoints CNPJ#

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

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 segundo5 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 alguns segundos.",
    "limit": 5,
    "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
400INVALID_CPFCPF inválido (formato ou dígito verificador)Valide o CPF antes de enviar
400MISSING_PARAMETERParâmetro obrigatório não foi enviadoVerifique os parâmetros requeridos
400INVALID_DATASETSDatasets solicitados são inválidosUse apenas datasets válidos
404COMPANY_NOT_FOUNDEmpresa não encontrada na base de dadosVerifique o CNPJ
404PERSON_NOT_FOUNDPessoa não encontrada no LinkedInVerifique o profile_public_id
402INSUFFICIENT_CREDITSSaldo insuficiente no workspaceAdicione créditos via dashboard
408REQUEST_TIMEOUTTempo limite excedido na consultaTente novamente
500INTERNAL_ERRORErro interno do servidorTente novamente ou entre em contato
503SERVICE_UNAVAILABLEServiço temporiamente indisponívelTente novamente em alguns minutos

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: contato@kipflow.io
Website: https://kipflow.io
Dashboard: https://platform.kipflow.io

Boas Práticas#

Performance#

1.
Cache: Armazene dados que não mudam frequentemente
2.
Batch: Use buscas com filtros ao invés de múltiplas consultas individuais
3.
Datasets: Solicite apenas os dados necessários
4.
Compressão: Habilite gzip nas requisições

Segurança#

1.
API Keys: Nunca exponha em código cliente ou repositórios públicos
2.
Rotação: Rotacione keys periodicamente
3.
Múnimas Keys: Crie keys específicas por ambiente ou serviço
4.
Monitoramento: Acompanhe uso anormal no dashboard

Confiabilidade#

1.
Retry Logic: Implemente retry automático com backoff exponencial
2.
Timeout: Configure timeouts adequados (recomendado: 30s)
3.
Circuit Breaker: Implemente para evitar cascata de falhas
4.
Logging: Registre requests e responses para debug
Modificado em 2026-04-14 16:50:01
Próxima página
Guia de Filtros da API - Consulta de Empresas
Built with