Skip to main content
GET
/
me
cURL
curl --request GET \
  --url https://sandbox.onconsul.com/v1/me \
  --header 'Authorization: Bearer <token>'
{
  "entity_id": "<string>",
  "scopes": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.onconsul.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the authenticated caller’s self-view: the credential type, the owning entity, and the scopes granted to the request. Useful as a smoke test that your Authorization header is wired correctly and that the scopes attached to your API key cover the endpoints you intend to call.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

OK

​
auth_type
enum<string>
required
Available options:
api_key
​
entity_id
string
required
​
entity_type
enum<string>
required
Available options:
organization,
individual
​
scopes
enum<string>[]
required
Available options:
balance:read,
bank_accounts:read,
bank_accounts:write,
external_wallets:read,
external_wallets:write,
recipients:read,
recipients:write,
transactions:read,
deposits:read,
deposits:write,
withdrawals:read,
withdrawals:write,
payouts:read,
payouts:write,
webhooks:read,
webhooks:write