Campos e normalização

O que são os campos

A saída da API é controlada por output.fields. Cada plano possui uma lista de campos permitidos (allowlist). Consulte GET /v1/status (ver Status) para ver a lista atual.

Campos mais comuns

Identificadores

• cnpj
• uf
• municipality_ibge

Empresa

• legal_name
• trade_name
• cnae_primary
• company_size_code
• registration_status
• started_at

Contato

• email
• phone1, area_code1
• phone2, area_code2
• has_email, has_phone

Endereço

• street_type, street, street_number
• address_complement, neighborhood, postal_code

Normalização

• Códigos (ex.: cnae_primary, municipality_ibge) são normalizados para formatos numéricos.
• Campos ausentes podem vir vazios ou nulos, dependendo do formato de saída.

Dica

Se output.fields estiver vazio, a API aplica o default do plano.