Create an API key

POST

/api-keys

Generates a new API key pair for the authenticated identity. On success, both the public key and the secret key are returned. The secret key is returned in plaintext exactly once and is never stored — you must save it immediately. Subsequent reads will not expose the secret. Each identity can have multiple API keys, but each must have a unique name within the same identity. The identity_id, entity_id, and created_by fields are all derived from the bearer token and cannot be set by the client. Optionally scope the key's permissions with acl, using recognised ACL permission names; unrecognised names are rejected.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

API key created successfully. The secret_key field is included in this response only — it will not be returned again.

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

Request Example

Shell

JavaScript

Java

Swift

cURL

Minimal — required fields onlyWith expiry date setAll optional fields set

curl --location '/api-keys' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Production Server Key",
    "environment": "live"
}'

Response Example

201 - Success

{
    "message": "API key created successfully",
    "status": "success",
    "data": {
        "id": "01J5X8PMKW3RNVBQE2D7F9GHAT",
        "name": "Production Server Key",
        "environment": "live",
        "identity_id": "01J5X8PMKW3RNVBQE2D7F9GHBT",
        "public_key": "pk_live_8f2a1c7d3e9b4f5a",
        "secret_key": "sk_live_3e9b4f5a8f2a1c7d",
        "expires_at": null,
        "status": "active",
        "acl": null,
        "config": null,
        "created": 1754478720000
    }
}

Modified at 2026-09-28 09:30:41

Retrieve an account's daily payout limit status

List API keys