Skip to main content
POST
/
v1
/
admin
/
api-keys
Mint an API key for a partner
curl --request POST \
  --url http://localhost:3000/v1/admin/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment": "sandbox",
  "scopes": [
    "partner:write"
  ],
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key": "<string>",
  "key_id": "<string>",
  "key_prefix": "<string>",
  "environment": "sandbox",
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scopes": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>",
  "created_at": "<string>",
  "warning": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
partner_id
string<uuid>
required
environment
enum<string>
required
Available options:
sandbox,
production
scopes
string[]
Minimum array length: 1
Required string length: 1 - 64
name
string
Required string length: 1 - 120
description
string
Maximum string length: 2000

Response

201 - application/json

Default Response

id
string<uuid>
required
key
string
required
key_id
string
required
key_prefix
string
required
environment
enum<string>
required
Available options:
sandbox,
production
partner_id
string<uuid>
required
scopes
string[]
required
name
string | null
required
description
string | null
required
created_at
string
required
warning
string
required