v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB

OAuth API Keys

Check OAuth API key existence

The endpoint returns whether a partner-issued API key already exists for the authenticated user and OAuth2 client pair. Use the endpoint before redirecting the user to the OAuth API key flow — when a key already exists, skip the redirect and surface the appropriate message to the user.

Required scope: apikeys.read.

Region availability: The endpoint is available on the global server (https://whitebit.com) only.

get/oauth2/api-key/info

Response

Successful response

Example response

{
  "data": {
    "exists": true,
    "isEnabled": true,
    "externalId": "550e8400-e29b-41d4-a716-446655440000",
    "permissions": [
      {
        "name": "trading",
        "title": "Trading",
        "urls": [
          {
            "url": "/v2/order",
            "enable": true
          }
        ]
      }
    ]
  }
}