Skip to main content
POST
Create a user API key

Authorizations

Authorization
string
header
required

Bearer session token for User API operations. Legacy UserSessionBearer naming remains supported.

Body

application/json
scopes
enum<string>[]
Available options:
users.read,
users.write,
kyc.read,
kyc.write,
agreements.read,
agreements.write,
onboarding.read,
onboarding.write,
cards.read,
cards.write,
cards.secrets.read,
folders.read,
folders.write,
balances.read,
contracts.read,
contracts.write,
deposits.read,
deposits.write,
withdrawals.write,
transactions.read,
tokens.read,
encryption.read,
encryption.write,
identity.read,
identity.write,
payments.read,
payments.write,
subscriptions.read,
subscriptions.write,
notifications.read,
notifications.write,
referrals.read,
referrals.write,
bills.read,
bills.write,
support.read,
spotlight.read,
keys.read,
keys.write,
sessions.write
policy
object

Response

Success

consumerApiKey
string

Returned once at creation time.

consumerKeyId
string
keyPrefix
string
walletAddress
string
userId
string | null
scopes
string[]
userApiKey
string

Returned once at creation time.

userKeyId
string