Skip to main content
Create API Key

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Body

application/json
name
string
required

Human-readable name for the API key

permissions
enum<string>[]
required

List of permissions granted to this API key

Minimum array length: 1
Available options:
read:all,
write:all,
read:disbursements,
write:disbursements,
read:receivers,
write:receivers,
read:payments,
write:payments,
read:organization,
write:organization,
read:users,
write:users,
read:wallets,
write:wallets,
read:distribution_wallets,
write:distribution_wallets,
read:statistics,
read:exports
distribution_wallet_ids
string[]

IDs of the distribution accounts this key may act on. Omit the field to inherit the accounts its creator can reach at that moment. An empty array grants no account access. A key cannot be scoped to an account its creator cannot reach.

expiry_date
string<date-time>

Optional expiration date for the API key (must be in the future)

allowed_ips

IP restrictions for the API key. If not provided, the key can be used from any IP

Response

API key created successfully

id
string

Unique identifier for the API key

name
string

Human-readable name for the API key

key
string

The actual API key (only returned once at creation)

permissions
string[]

List of permissions granted to this API key

allowed_ips
string[]

List of allowed IP addresses or CIDR ranges

distribution_wallet_ids
string[]

IDs of the distribution accounts this API key may act on.

expiry_date
string<date-time>

Expiration date of the API key

created_at
string<date-time>

When the API key was created

created_by
string

User who created the API key

updated_at
string<date-time>

When the API key was last updated

updated_by
string

User who last updated the API key

last_used_at
string<date-time>

When the API key was last used