Skip to main content

​
Endpoint

POST https://api.thiqwave.com/v1/partners

​
Description

Register a new sub-partner in the platform. When you create a sub-partner, Thiqwave provisions an account for that business and returns an API key they can use to call the Thiqwave API directly under your partner umbrella.

​
Request

​
Headers

​
X-API-Key
string
required
Your Thiqwave API key.
​
Content-Type
string
required
Must be application/json.

​
Body

​
name
string
required
The legal business name of the sub-partner.
​
email
string
required
Primary contact email address for the sub-partner. Must be a valid email and unique across the platform.
​
businessType
string
required
The type of business. Common values include "fintech", "marketplace", "ecommerce", and "remittance".
​
country
string
required
The sub-partner’s country of operation. Must be an ISO 3166-1 alpha-2 code. Supported values: "SA" (Saudi Arabia) or "AE" (United Arab Emirates).

​
Example request

curl -X POST https://api.thiqwave.com/v1/partners \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Noon Payments LLC",
    "email": "api@noonpayments.ae",
    "businessType": "marketplace",
    "country": "AE"
  }'

​
Response

A 201 Created response returns the newly created partner object.
​
id
string
The unique identifier for the partner. Use this ID to reference the partner in subsequent API calls.
​
name
string
The business name of the sub-partner.
​
email
string
The primary contact email address.
​
status
string
The current onboarding status of the partner. Possible values: "pending", "active", "suspended".
​
apiKey
string
The API key provisioned for the new sub-partner. Share this securely with the sub-partner — it is only returned once.
​
createdAt
string
The ISO 8601 timestamp of when the partner was created.

​
Example response

{
  "id": "prtnr_01HZ2KJ8VBNC4W3M9RFQTX6YP",
  "name": "Noon Payments LLC",
  "email": "api@noonpayments.ae",
  "status": "pending",
  "apiKey": "tq_live_4f8a2c1d9e3b7f0a5c6d2e8f1a3b9c4d",
  "createdAt": "2026-04-08T10:32:00Z"
}
The apiKey field is only returned at creation time. Store it securely immediately — you cannot retrieve it again. If it is lost, you must generate a new key from the dashboard.

​
Error responses

StatusCodeDescription
400VALIDATION_ERROROne or more request fields are invalid or missing. The response body includes a details array describing each validation failure.
409DUPLICATE_EMAILA partner with the given email address already exists on the platform.
401UNAUTHORIZEDYour API key is missing or invalid.
403FORBIDDENYour account does not have permission to create sub-partners.