Create Api Key

POST

/partners/api-keys

Generates an API key for a partner and returns the plaintext key once along with its hashed version stored in the database. Admins must capture the plaintext key at creation time and share it securely with the partner.

Request

Authorization

OAuth 2.0

Password

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: token

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful Response

Body

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/partners/api-keys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "notes": "string",
    "partner_id": "6a3a39f6-861b-4a48-b868-5de838400e06"
}'

Response Example

200 - Example 1

{
    "notes": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "active": true,
    "key": "string"
}

Modified at 2025-12-09 11:25:33

Create Partner

Update Charge Fee