Customers

Join a sandbox Product through a join link

Redeems a join link: creates a sandbox test customer from the first name, activates its enrollment in the link's Product, opens its customer_balance account, funds it with the link's test money, and signs it in. The session is bound to that one customer and Product, and ends no later than the link does. An unknown token is not found, an expired link is refused as expired, and a link that has admitted maxJoins people is refused as full. Each call makes a new customer; the same person joining twice is two customers. The session token is a one-time secret surfaced only in this response.

post/v1/customer-identity/join

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/customer-identity/join
  • Auth: none required

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

tokenstring required

The secret in a join link's URL path, after /j/. Whoever holds it can join the link's Product as a sandbox customer until the link expires or fills.

firstNamestring required

The only thing a guest gives. It becomes the display name.

Response

Success

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

environment'sandbox' | 'live' required
customerIdstring required

Tenant-local customer ID

entityIdstring required

Hyperscale entity ID

displayNamestring required
customerAccessIdstring required

Hyperscale customer access ID

customerAccessStatus'pending' | 'active' | 'suspended' | 'closed' required
accountIdstring required

Hyperscale account ID

fundingTransferIdstring required

Hyperscale transfer ID

fundingAmountstring required

Positive minor-unit integer amount serialized as a string (at most 18 digits)

currency'SAR' required
customerSessionIdstring required

Hyperscale end-customer session ID

sessionTokenstring

One-time session token surfaced only in the first response; receipts and replays omit it

sessionExpiresAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.