Sign in

v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
OAuth API Keys

Retrieve OAuth API key secret

The endpoint retrieves the API secret for a partner-issued API key. The endpoint returns the secret exactly once per key — a subsequent call returns 409 Conflict.

Required scope: apikeys.read.

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

<Warning> Store the API secret in encrypted backend storage on first retrieval. The secret is not recoverable after this call returns. </Warning>
get/oauth2/api-key/{externalId}/secret

Path parameters

externalIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

External UUID of the API key. Obtain the value from GET /oauth2/api-key/info.

Response

Successful response. The secret is returned exactly once.

Example response

{
  "data": {
    "apiSecret": "YOUR_API_SECRET"
  }
}