Create Api Key

POST

/api/v1/merchants/api-keys

Create API key for authenticated merchant (requires x-api-key authentication).

The merchant_id is automatically extracted from the x-api-key header.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful Response

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/merchants/api-keys' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "aws backend"
}'

Response Example

200 - Success

{
    "data": {
        "id": "36dfedbc-3568-4b4a-8dfd-1f778476ef50",
        "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
        "key_name": "aws backend",
        "key_hash": "mk_atQnAmDq9s5LCj7D7hM5yvc7KBSw43sVFQviU",
        "key_prefix": "ONzK5zQnPF",
        "status": "active",
        "scope": "FULL_ACCESS",
        "permissions": [
            "read",
            "write"
        ],
        "expires_at": null,
        "last_used_at": null,
        "created_by": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
        "revoked_at": null,
        "revoked_by": null,
        "api_key_metadata": null,
        "created_at": "2025-11-19T16:16:50.676891",
        "updated_at": "2025-11-19T16:16:50.676891",
        "deleted_at": null
    },
    "message": "API key created successfully",
    "status": "success"
}

Modified at 2025-11-19 15:16:54

Get Api Keys