Customers

Create a customer

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. Accounts and money movement stay refused until the entity clears person KYC or organization KYB and the access is activated, in both environments. In sandbox, test: true creates a test customer with a synthetic legal profile and active access in one call; live refuses it.

post/v1/customers

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/customers
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

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

Request body

productIdstring required

Hyperscale product ID

testtrue

Sandbox only. Fills a synthetic, clearly fake legal profile when none is given and activates Product access in the same call.

Response

Success

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

customerIdstring required

Tenant-local customer ID

partyIdstring required
customerStatus'active' required
entityIdstring required

Hyperscale entity ID

entityStatus'pending' | 'verified' | 'rejected' | 'disabled' | 'not_checked' required

The legal entity's verification: pending until person KYC or organization KYB clears. A test customer never runs verification, so it reads not_checked and blocks nothing; identity reads test and its access is active.

identity'test' | 'pending' | 'verified' | 'rejected' | 'disabled' required

One word for the customer's identity: test for a test customer, otherwise entityStatus.

customerAccessIdstring required

Hyperscale customer access ID

customerAccessStatus'active'

Changes

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