Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

Cognito JWT token for regular user authentication

Body

permissions
enum<string>[]
required
Minimum array length: 1
Available options:
bank-accounts:read,
bank-accounts:write,
bank-accounts:delete,
bills:read,
bills:delete,
off-ramp-quotes:read,
off-ramp-quotes:write,
off-ramps:refund
expiresAt
string<date-time>

ISO 8601 expiration timestamp

name
string
Required string length: 1 - 255

Response

Response for status 200

id
string
required
keyPrefix
string
required
rawKey
string
required

The raw API key. Store securely — it will not be shown again.

permissions
string[]
required
name
string | null
required
expiresAt
string<date-time> | null
required
createdAt
string<date-time>
required
warning
string
required