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

Exemplo — Enriquecer inbound

Cenário

Você recebe apenas o nome da empresa (ou domínio) no inbound e precisa classificar a empresa por segmento e porte.

Requisição

json
Testar
{
  "spec": {
    "kind": "account_query",
    "spec_version": "2.0",
    "entity": "company",
    "limit": 5,
    "filters": {
      "industry": {
        "cnae_any_of": ["5229-0/99"],
        "cnae_exclude": [],
        "secondary_cnae_mode": "off",
        "text_hints": ["logística"]
      },
      "geo": {
        "uf_any_of": [],
        "municipality_ibge_any_of": [],
        "municipality_tom_any_of": []
      },
      "company": {
        "registration_status_any_of": [],
        "company_size_code_any_of": [],
        "headquarters_only": true,
        "simples_opt_in": null,
        "mei_opt_in": null,
        "started_after": null,
        "started_before": null
      },
      "contact": {
        "require_email": false,
        "require_phone": false,
        "require_any_contact": false
      }
    },
    "sort": [],
    "scoring": { "strategy": "balanced", "random_seed": null },
    "output": {
      "format": "json",
      "include_explain": true,
      "fields": ["cnpj", "legal_name", "cnae_primary", "company_size_code", "registration_status"]
    },
    "explain": {
      "assumptions": [],
      "warnings": [],
      "unmapped_constraints": [],
      "confidence": 0.9
    }
  }
}

Resposta (resumo)

json
{
  "accounts": [
    {
      "cnpj": "00000000000000",
      "legal_name": "EXEMPLO SA",
      "cnae_primary": "6201500",
      "company_size_code": "3",
      "registration_status": "2"
    }
  ]
}

Observação: a resposta completa inclui spec normalizado e request_id.

Boas práticas

  • Valide o spec no Studio antes de integrar no pipeline.
  • Salve o request_id para auditoria.