Customer sign-in

Log in an end customer to a product

Verifies an end customer's password against the company's own customer credentials and mints a session bound to the named Product. The lookup is by email within the company, so the same address at two companies is two unrelated customers by design. A customer with no enrollment in that Product cannot sign in to it, and a suspended or closed enrollment is refused; a pending one succeeds, because completing verification is something the customer does while signed in. The session token is a one-time secret surfaced only in this response, never in receipts or replays.

post/v1/customer-identity/login

Request

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

Headers

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

Request body

productIdstring required

The Product to sign in to. One credential spans the company; each session is minted for exactly one of its Products.

emailstring email required
passwordstring required

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

Changes

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