Customers

Retrieve a Customer

Retrieve a single Customer by its customerId. A person or business your company serves. Access to each Product is granted separately. Identity facts live on the linked entity; this record carries the display name, external reference, and status.

get/v1/customers/{customerId}

Request

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

Path parameters

customerIdstring required

Query parameters

productIdstring

Hyperscale product ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

customerIdstring required

Tenant-local customer ID

tenantIdstring required

Organization tenant ID

displayNamestring required
entityIdstring

Hyperscale entity ID

entityKind'person' | 'organization' required
entityCountrystring required
entityStatus'pending' | 'verified' | 'rejected' | 'disabled' | 'not_checked' required
profileStatus'missing' | 'complete' required
identity'test' | 'pending' | 'verified' | 'rejected' | 'disabled' required
principalIdstring required

Hyperscale principal ID

externalReferencestring nullable
status'pending' | 'active' | 'disabled' | 'erased'
createdAtstring date-time

Changes

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