Skip to main content
POST
Create an API key

Body Parameters

Available Scopes

Example Request

Response

The key field contains the full API key. Store it securely — it cannot be retrieved again.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Body

application/json
name
string
mode
enum<string>
default:test
Available options:
test,
live

Response

Key created.

id
string<uuid>
tenant_id
string<uuid>
key_value
string

Raw API key. Populated only in the creation response — never on list.

key_prefix
string

First characters of the key, for display and lookup.

type
string
Example:

"secret"

is_active
boolean
livemode
boolean

true for a live key (rsk_live_), false for a test key (rsk_test_).

created_at
string<date-time>