API reference › Connectivity › Whoami

Identity and connectivity check

GET /v1/whoami

Scope
none:read

Confirms the key resolves, and reports the user it acts as.

Exempt from the scope check — any valid key may call this whatever scopes it holds, because the response contains only the caller's own identity and its own scope list. Authentication, expiry, the per-organization kill switch, IP allow-list, tenant pinning and rate limits all still apply.

Send X-Tenant-ID for org and user tier keys; platform keys may omit it.

Parameters

None of its own.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/whoami" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 The key is valid

The key is valid.

JSON
{
  "success": true,
  "message": "ok",
  "data": {
    "user_id": "string",
    "name": "string",
    "tier": "platform",
    "role": "string",
    "scopes": [
      "finance:read",
      "finance:write"
    ],
    "tenant_id": "string"
  }
}
Response fields (9)
FieldTypeDescription
successboolean

Example true.

messagestring

Example ok.

dataobject
data.user_idstring

The user the key acts as.

data.namestring or null
data.tierstring

One of: platform, org, user.

data.rolestring or null

Role slug of the key owner, e.g. super-admin.

data.scopesarray of string
data.tenant_idstring or null

Echo of the X-Tenant-ID header as sent.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.