Pular para o conteúdo

Conta e empresa

As rotas de conta e empresa usam a raiz de CNPJ vinculada à chave. Elas não representam a conta pessoal de quem criou a credencial e não listam outras empresas às quais essa pessoa tenha acesso.

Todas exigem conta:ler.

Rota Conteúdo
GET /v1/conta ID não secreto da credencial, raiz de CNPJ, escopos e expiração.
GET /v1/empresa CNPJ principal, raiz, razão social e estado da empresa.
GET /v1/empresa/capacidades Plano informado, capacidade e cobertura da vigilância, além da disponibilidade de análise.

Produtos canônicos compartilhados entre filiais contam uma vez. O objeto vigilancia informa:

  • cadastrados, selecionados e elegiveis;
  • capacidade e vagas;
  • modo, versao, direito_ativo, cobertura e exige_selecao.

O objeto analise informa situacao, que pode ser liberada ou limite, e disponivel_em quando houver uma janela vigente de espera.

Consultar capacidade não contrata plano, não muda a seleção, não consome análise e não comprova que uma vigilância foi executada. A operação que solicitar a análise revalida a disponibilidade.

Essas respostas não expõem CPF, e-mail pessoal, membros, endereço, cobrança, segredo da chave ou conteúdo do Catálogo de Produtos. Use os fluxos humanos autorizados para administrar pessoas, credenciais, titularidade e cobrança.