Who am I (user or machine credential)

GET

/broker/me

const url = 'https://api.hedgespecialty.com/api/v1/broker/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.hedgespecialty.com/api/v1/broker/me \
  --header 'Authorization: Bearer <token>'

Returns the authenticated identity plus the brokerage. Two shapes, discriminated by kind:

kind: user (portal session or per-user OAuth token): id, email, full_name, role, brokerage, active_states.
kind: api_client (machine credential): client_id (the public bac_... identifier), label, scope (the token’s granted scopes), brokerage, active_states.

active_states lists the US states Hedge is currently active in; null means no gating (all states).

Authorizations

brokerOAuth

Responses

200

Identity (user shape or api_client shape)

401

Account or credential is no longer active