3.1. Bureaus Habilitados¶

Endpoint¶

Método	URL
	`/bureaus/habilitados`

Descrição¶

Lista os bureaus habilitados para o grupo econômico informado no header GrupoEconomico. É o primeiro passo da integração: confirma que a credencial está vinculada ao grupo e que o SCR está liberado antes de você solicitar a primeira consulta.

Esta rota não gera custo e pode ser chamada a qualquer momento — por exemplo, na inicialização do seu sistema ou antes de exibir a opção de consulta ao usuário.

Headers¶

Apenas os headers padrão (Authorization e GrupoEconomico). Ver 1.1.2 Autenticação.

Exemplo de cURL¶

curl -X GET "https://api.vehub.com.br/public/v1/bureaus/habilitados" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

Responses¶

200 OK — SCR habilitado¶

[
  { "id": 1, "nome": "SCR" }
]

Campo	Tipo	Descrição
id	integer	Identificador do bureau. Ver 2.1. Enumerações
nome	string	Nome do bureau

200 OK — nenhum bureau habilitado¶

O grupo não tem nenhum bureau liberado. Não é erro: a lista vem vazia.

[]

401 Unauthorized¶

Token ausente, expirado ou inválido, ou header GrupoEconomico ausente:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.2",
  "status": 401,
  "errors": [
    { "campo": null, "mensagem": "Header GrupoEconomico não informado. Por favor, forneça um Grupo Econômico válido." }
  ]
}

403 Forbidden¶

A credencial não está vinculada ao grupo econômico informado:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.4",
  "status": 403,
  "errors": [
    { "campo": null, "mensagem": "A credencial seu-client-id não está habilitada para o grupo econômico MeuGrupo." }
  ]
}

Próximo passo¶

Com o SCR na lista, colete o aceite do titular e solicite a consulta em 3.2. Solicitar Consulta.

Observações¶

Lista vazia não é erro. Se o SCR não aparece, a habilitação do grupo ainda não foi feita (ou foi retirada). Nesse caso, as rotas /bureaus/scr respondem 403. Fale com o nosso time.
403 nesta rota é problema de credencial, não de habilitação do bureau: confira o clientId e o nome do grupo enviado em GrupoEconomico.
A habilitação vale para todas as credenciais vinculadas ao grupo.