AUTHENTICATION

Inspect the authenticated API key

GET/v1/auth/whoami

Returns non-secret metadata about the key used for this request. Available to scoped keys without granting additional permissions; responses are not cacheable.

Backend integrationYour backend and SDK use a tenant API key.

Try itAvailable for creating, reading, and deleting verification sessions in Test. Other operations are reference-only; API-key protected routes require a tenant API key on your backend. Open a session request

Responses

Response 200

JSON response

application/json · Response schema

client_idstringrequired
api_key_idstring,nullrequired: Null for legacy keys without a lifecycle identifier.
scopesarray,nullrequired: Null means an unrestricted legacy or operator key.
modestringrequired: Effective environment selected for this request.
Allowed valuestestlive
expires_atstring,null · date-timerequired

View JSON schema

{
  "type": "object",
  "required": [
    "client_id",
    "api_key_id",
    "scopes",
    "mode",
    "expires_at"
  ],
  "properties": {
    "client_id": {
      "type": "string"
    },
    "api_key_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Null for legacy keys without a lifecycle identifier."
    },
    "scopes": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "enum": [
          "session:create",
          "session:read",
          "audit:read",
          "api_keys:manage"
        ]
      },
      "description": "Null means an unrestricted legacy or operator key."
    },
    "mode": {
      "type": "string",
      "enum": [
        "test",
        "live"
      ],
      "description": "Effective environment selected for this request."
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

Response 401

Missing or invalid API key

application/json · Response schema

errorstringrequired
messagestringrequired

View JSON schema

{
  "type": "object",
  "required": [
    "error",
    "message"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Response 429

Rate limit exceeded

application/json · Response schema

errorstringrequired
messagestringrequired

View JSON schema

{
  "type": "object",
  "required": [
    "error",
    "message"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

← All public operations