Skip to navigation
API ReferenceAuthentication

Create a new api key for this user

This endpoint creates an api key and returns the key id along with the secret. The secret is in hexadecimal encoding and will not be available again after this call

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
subAccountIdstringRequiredformat: "uuid"

The unique identifier for the sub-account on which the api key will receive permissions

requestedPermissionsobjectRequired
challengestringRequiredformat: "uint64"
The 2FA code generated by the user via their TOTP secret
codestringRequiredformat: "uint64"
The code received via email by the user as a result of the call to SendApiKeyValidationCode
labelstringOptional

A safe-string label acting as a mnemonic to the user, typically it would describe the role of the api-key that is going to be created

Response

A successful response.
resultobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error