Base URL: https://api.orbioapi.com.br

GET /v1/status

Base URL: https://api.orbioapi.com.br

Endpoint público de status da API (não requer autenticação).

Resposta (200 OK)

json
{
  "active_snapshot": "2026-01",
  "snapshot_date": "2026-01-01",
  "allowed_sort_fields": ["score", "started_at", "legal_name", "uf", "municipality_ibge", "company_size_code"],
  "field_allowlist": [
    "cnpj",
    "legal_name",
    "trade_name",
    "uf",
    "municipality_ibge",
    "cnae_primary",
    "company_size_code",
    "registration_status",
    "started_at",
    "has_email",
    "has_phone",
    "email",
    "phone1",
    "area_code1",
    "phone2",
    "area_code2",
    "street_type",
    "street",
    "street_number",
    "address_complement",
    "neighborhood",
    "postal_code"
  ]
}

Notas

  • field_allowlist indica os campos liberados no plano (lista de referência).
  • allowed_sort_fields mostra quais campos podem ser usados para ordenação.