Retrieve an environment

GET

environments

:id

curl https://api.zquence.ai/v1/environments/69f9b5fa0600ccbf9c677005 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "id": "69f9b5fa0600ccbf9c677005",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Staging Sandbox",
  "type": "sandbox",
  "status": "active",
  "apiVersion": "v1",
  "webhookRetries": 3,
  "debugLogging": true,
  "rateLimitPerMinute": 120,
  "createdAt": "2026-02-04T11:30:00.000Z",
  "updatedAt": "2026-06-01T09:45:00.000Z"
}

{
  "statusCode": 403,
  "message": "You do not have access to this environment"
}

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

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 400,
  "message": "tenantId missing for environment request"
}

Returns the full environment record for the given ID. Returns 404 if the environment does not exist or belongs to a different tenant.

An API key is bound to exactly one environment. Asking for any other environment ID — including another one inside your own tenant, and in particular the live environment from a sandbox key — returns 403, not the record. Use Retrieve active environment to get the one your key is bound to.

Path parameters

string

required

The environment’s MongoDB ObjectId, as returned by List environments.

Returns

string

Environment ID (MongoDB ObjectId).

string

Owning tenant identifier.

string

Human-readable display name (e.g. "Live", "Staging Sandbox").

string

Environment type — "live" or "sandbox".

string

"active" or "disabled". Disabled environments reject all incoming API requests.

string

API version configured for this environment. Currently always "v1".

number

Number of webhook delivery retry attempts. Default 3.

boolean

When true, extended logs are captured for this environment. Default false.

number | null

Per-minute API rate-limit override. null or absent means the tenant-level default applies.

string

ISO 8601 UTC creation timestamp.

string

ISO 8601 UTC last-modified timestamp.

Error codes

Status	Meaning
`400`	`tenantId` could not be resolved from the authenticated credential.
`401`	Missing or invalid API key pair.
`403`	The API key is not bound to this environment.
`404`	No environment with this ID exists under the authenticated tenant.

curl https://api.zquence.ai/v1/environments/69f9b5fa0600ccbf9c677005 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "id": "69f9b5fa0600ccbf9c677005",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Staging Sandbox",
  "type": "sandbox",
  "status": "active",
  "apiVersion": "v1",
  "webhookRetries": 3,
  "debugLogging": true,
  "rateLimitPerMinute": 120,
  "createdAt": "2026-02-04T11:30:00.000Z",
  "updatedAt": "2026-06-01T09:45:00.000Z"
}

{
  "statusCode": 403,
  "message": "You do not have access to this environment"
}

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

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 400,
  "message": "tenantId missing for environment request"
}

curl https://api.zquence.ai/v1/environments/69f9b5fa0600ccbf9c677005 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "id": "69f9b5fa0600ccbf9c677005",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Staging Sandbox",
  "type": "sandbox",
  "status": "active",
  "apiVersion": "v1",
  "webhookRetries": 3,
  "debugLogging": true,
  "rateLimitPerMinute": 120,
  "createdAt": "2026-02-04T11:30:00.000Z",
  "updatedAt": "2026-06-01T09:45:00.000Z"
}

{
  "statusCode": 403,
  "message": "You do not have access to this environment"
}

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

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 400,
  "message": "tenantId missing for environment request"
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Retrieve an environment

Path parameters

Returns

Error codes

​Path parameters

​Returns

​Error codes

Path parameters

Returns

Error codes