Guia

Account Discovery API no Brasil

Como gerar listas de contas com CNAE, UF, base mensal fixa e export em volume.

Checklist do perfil desejado

  • Defina CNAE principal no formato 0000-0/00.
  • Restrinja por UF ou município para evitar buscas amplas.
  • Decida se a operação precisa de e-mail, telefone ou qualquer contato.
  • Use a base do mês para repetibilidade comercial e analítica.

Exemplo de request

bash
curl -X POST "https://api.orbioapi.com.br/v1/accounts/search" \
  -H "Authorization: Bearer $ORBIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "spec": {
      "kind": "account_query",
      "spec_version": "2.0",
      "entity": "company",
      "limit": 20,
      "filters": {
        "industry": { "cnae_any_of": ["6201-5/00", "6202-3/00"], "secondary_cnae_mode": "off" },
        "geo": { "uf_any_of": ["SP"] },
        "company": { "registration_status_any_of": [2], "headquarters_only": true },
        "contact": { "require_email": true }
      }
    },
    "output": {
      "format": "json",
      "fields": ["cnpj", "legal_name", "uf"]
    }
  }'

Campos recomendados

  • cnpj, legal_name, uf, municipality_ibge
  • cnae_primary, company_size_code, registration_status
  • email e phone1 quando a operação exigir contato

Erros comuns

  • Query ampla demais: adicione UF e CNAE principal.
  • Snapshot ignorado: salve a base do mês para reproduzir listas antigas.
  • Volume alto no sync: migre para export assíncrono.

Quando usar este fluxo

Esse é o guia base para account discovery. A partir dele, faça o recorte por CNAE, leve a lista para export CSV e compare as abordagens quando o caso pedir.

Próximos passos

Para grandes volumes, mantenha o snapshot do mês visível e feche o fluxo com exports assíncronos.