---
title: "Read the signed-in end customer's balance and activity"
method: GET
path: "/v1/customer-identity/me"
tags: ["Customers"]
---

# Read the signed-in end customer's balance and activity

`GET /v1/customer-identity/me`

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/customer-identity/me`
- Auth: HTTP bearer

Answers for the customer the session belongs to and no one else: the request names no customer or account, so a session can never read another customer. Returns each of the customer's accounts in the session's Product with its balance, and the money movements on them. A customer's actions and records come from the product.objects operations, which accept the same session.

## Query parameters

- `productId` string, required: The Product the session is bound to, as customer.join returned it. Any other Product is refused.

## Headers

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

## Response `200`

Success

- CustomerMeRetrieveOutput
  - `tenantId` string, required: Organization tenant ID
  - `productId` string, required: Hyperscale product ID
  - `environment` 'sandbox' | 'live', required
  - `customerId` string, required: Tenant-local customer ID
  - `accounts` object[], required
    - `accountId` string, required: Hyperscale account ID
    - `role` 'tenant_billing' | 'tenant_credit' | 'tenant_settlement' | 'customer_balance' | 'customer_investment' | 'product_pool' | 'product_credit' | 'product_revenue', required
    - `currency` 'SAR', required
    - `available` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
    - `settled` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
    - `pending` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
    - `asOf` string, date-time, required
  - `activity` object[], required: Money in and out of the customer's own accounts this month on the Product's clock, newest first, at most 50.
    - `amount` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
    - `balanceDelta` string, required: Signed minor-unit integer amount serialized as a string (at most 18 digits)
    - `counterpartyAccountId` string, required: Hyperscale account ID
    - `counterpartyDisplayName` string, required
    - `currency` 'SAR', required
    - `direction` 'debit' | 'credit', required
    - `entryId` string, required
    - `ledgerTransferId` string, required
    - `memo` string, required
    - `occurredAt` string, date-time, required
    - `operationId` string, required: Hyperscale operation ID
    - `operationName` string, required
    - `origin` object
      - `instrumentId` string, required
      - `instrumentInstanceId` string, required
      - `action` string, required
    - `runningBalance` string, required: Negative only on a contra claim account, where it is what the owner owes.
    - `status` 'pending' | 'posted' | 'voided', required
    - `title` string
    - `transferId` string, required: Hyperscale transfer ID
    - `accountId` string, required: Hyperscale account ID

## Other responses

- `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance.

---

[API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)