Create a customer
customer.create
Creates a customer for your company with its underlying legal entity, capturing the entity kind, display name, and country of registration, and opens pending access to one Product. The customer starts active; the entity starts pending (unverified), and so does the Product access.
POST /v1/customers
Scopes: customer:write
Input
| Field | Type | Description |
|---|---|---|
productId required | string | Hyperscale product ID |
entity required | object | |
test | boolean | Sandbox only. Fills a synthetic, clearly fake legal profile when none is given and activates Product access in the same call. |
idempotencyKey required | string | New per change; reuse only to retry it. |
Request sample
curl --request POST 'https://console.hyperscale0.ai/v1/customers' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
"productId": "<string>",
"entity": "<object>",
"idempotencyKey": "<string>"
}'