Retrieve a customer

GET

users

:id

curl https://api.zquence.ai/v1/users/6a25cdac36bc6230704b5b59 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "id": "6a25cdac36bc6230704b5b59",
  "name": "James Carter",
  "email": "james.carter@example.com",
  "phone": "+447911123456",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "role": "user",
  "status": "active",
  "memberships": [
    {
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "environmentName": "Staging Sandbox"
    }
  ],
  "createdAt": "2026-05-20T10:30:00.000Z",
  "updatedAt": "2026-06-07T20:00:12.414Z"
}

{
  "statusCode": 404,
  "message": "User not found"
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

Returns the user record scoped to the authenticated tenant. Returns 404 if the user does not exist or belongs to a different tenant.

Users are referred to as customers in the product UI. In the API they are /users resources. API-key callers require scope tenant-users.read and tenant permission user.view.one.

Path parameters

string

required

The user’s MongoDB ObjectId, as returned by List customers or the Add customer endpoint.

Returns

A full user object with environment memberships.

string

User ID (MongoDB ObjectId).

string

Full display name.

string

Email address.

string

Phone number in E.164 format.

string

Owning tenant identifier.

string | null

Primary environment this user belongs to.

string

User role — "user", "admin", "compliance", "support", "viewer".

string

Account status — "invited", "active", "disabled".

array

List of environment memberships. Each entry contains environmentId and environmentName.

string

ISO 8601 UTC creation timestamp.

string

ISO 8601 UTC last-updated timestamp.

Error codes

Status	Code	Meaning
`401`	`UNAUTHORIZED`	Missing or invalid authentication.
`403`	`FORBIDDEN`	Caller does not have `user.view.one` permission.
`404`	`NOT_FOUND`	No user with this ID exists under the authenticated tenant.

curl https://api.zquence.ai/v1/users/6a25cdac36bc6230704b5b59 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "id": "6a25cdac36bc6230704b5b59",
  "name": "James Carter",
  "email": "james.carter@example.com",
  "phone": "+447911123456",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "role": "user",
  "status": "active",
  "memberships": [
    {
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "environmentName": "Staging Sandbox"
    }
  ],
  "createdAt": "2026-05-20T10:30:00.000Z",
  "updatedAt": "2026-06-07T20:00:12.414Z"
}

{
  "statusCode": 404,
  "message": "User not found"
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

curl https://api.zquence.ai/v1/users/6a25cdac36bc6230704b5b59 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "id": "6a25cdac36bc6230704b5b59",
  "name": "James Carter",
  "email": "james.carter@example.com",
  "phone": "+447911123456",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "role": "user",
  "status": "active",
  "memberships": [
    {
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "environmentName": "Staging Sandbox"
    }
  ],
  "createdAt": "2026-05-20T10:30:00.000Z",
  "updatedAt": "2026-06-07T20:00:12.414Z"
}

{
  "statusCode": 404,
  "message": "User not found"
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Retrieve a customer

Path parameters

Returns

Error codes

​Path parameters

​Returns

​Error codes

Path parameters

Returns

Error codes