Customer sign-in

Sign up an end customer for a product

Creates an end customer's own login for one company: the credential, the underlying legal entity, the customer, and a pending enrollment in the named Product, then signs them in. The entity starts pending and the enrollment starts pending, exactly as customer.create leaves them. Verification is the customer's own act, never a side effect of signing up. No account is created and no money can move until the entity clears and the enrollment is activated. The email is the login handle and is unique per company, so the same person using two of a company's products is one customer with one password. The session token is a one-time secret surfaced only in this response, never in receipts or replays.

post/v1/customer-identity/signup

Request

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

Headers

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

Request body

productIdstring required

The Product being signed up for. The company is resolved from it, so a customer never names or chooses the company they belong to.

emailstring email required
passwordstring required
displayNamestring required
countrystring

ISO 3166-1 alpha-2 country code

termsAcceptedtrue required

Affirmative click-wrap acceptance of the company's terms. Signup refuses without it.

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

emailstring email required
customerAccessIdstring required

Hyperscale customer access ID

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

The Product enrollment this session was minted against. Signing in is allowed while enrollment is pending so the customer can complete verification; the Product's own actions stay refused until it is active.

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
displayNamestring required
customerStatus'pending' | 'active' | 'disabled' | 'erased' required
entityStatus'pending' | 'verified' | 'rejected' | 'disabled' required

Changes

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