Skip to main content
POST
/
v2
/
client-ids
curl --request POST \
  --url https://api.request.network/v2/client-ids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "label": "My Client ID",
  "allowedDomains": [
    "https://example.com"
  ]
}
'
{
  "id": "<string>",
  "clientId": "<string>",
  "label": "<string>",
  "allowedDomains": [
    "<string>"
  ],
  "feePercentage": "<string>",
  "feeAddress": "<string>",
  "status": "<string>",
  "createdAt": "<string>"
}

Headers

x-api-key
string
required

API key for authentication

Body

application/json
label
string
required
Required string length: 1 - 100
allowedDomains
string<uri>[]
required

List of allowed domain origins (normalized)

Required array length: 1 - 10 elements
feePercentage
string

Fee percentage (e.g., '1' = 1%, '2.5' = 2.5%, '2.55' = 2.55%). Maximum 2 decimal places. If set to '0', allows API request fees to take precedence. If set to any other value, overrides any fee passed via API.

Minimum string length: 1
feeAddress
string

Wallet address to receive fees. Required if feePercentage is set.

operatorWalletAddress
string

Wallet address that will act as operator for commerce payments. The API operator wallet will execute transactions on behalf of this address. Can be a smart wallet that has granted permissions to the API operator.

Response

Client ID created successfully

id
string
clientId
string
label
string
allowedDomains
string[]
feePercentage
string | null
feeAddress
string | null
status
string
createdAt
string