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
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.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.user_id | string | The user the key acts as. |
data.name | string or null | |
data.tier | string | One of: |
data.role | string or null | Role slug of the key owner, e.g. |
data.scopes | array of string | |
data.tenant_id | string or null | Echo of the X-Tenant-ID header as sent. |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |