Get KYC status

GET

kyc

status

:userId

curl https://api.zquence.ai/v1/kyc/status/usr_01HX3ZAB... \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "kycStatus": "complete",
  "userId": "usr_01HX3ZAB...",
  "tenantId": "tnt_01HX3Z8MQW...",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "environmentType": "live",
  "providerKycStatus": "approved",
  "submittedOn": "2026-04-22T10:34:00.000Z",
  "clientInformation": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "dob": "1815-12-10",
    "address": "27 Dorset Street, London",
    "country": "GB"
  }
}

{
  "statusCode": 404,
  "message": "KYC record not found"
}

Requires kyc.read. Returns a simplified KYC status response with only the essential status fields and client information. Use this endpoint to quickly check a user’s verification progress without retrieving the full KYC record. Fetches the KYC record by user ID.

Path parameters

string

required

The user ID to retrieve KYC status for.

Returns

string

Current KYC status — pending, in_progress, review, complete, or failed.

string

The user ID associated with this KYC record.

string

The tenant ID that owns this KYC record.

string

The environment ID where this KYC verification occurred.

string

Environment type — live or sandbox.

string

The Onfido provider’s verification status (if applicable).

string

ISO 8601 UTC timestamp when the user submitted their verification.

object

Full client information object provided during KYC setup, including fields like firstName, lastName, dob, address, country, etc.

Error codes

Status	Meaning
`401`	Missing or invalid API key pair.
`404`	KYC record not found or belongs to a different tenant.

curl https://api.zquence.ai/v1/kyc/status/usr_01HX3ZAB... \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "kycStatus": "complete",
  "userId": "usr_01HX3ZAB...",
  "tenantId": "tnt_01HX3Z8MQW...",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "environmentType": "live",
  "providerKycStatus": "approved",
  "submittedOn": "2026-04-22T10:34:00.000Z",
  "clientInformation": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "dob": "1815-12-10",
    "address": "27 Dorset Street, London",
    "country": "GB"
  }
}

{
  "statusCode": 404,
  "message": "KYC record not found"
}

curl https://api.zquence.ai/v1/kyc/status/usr_01HX3ZAB... \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "kycStatus": "complete",
  "userId": "usr_01HX3ZAB...",
  "tenantId": "tnt_01HX3Z8MQW...",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "environmentType": "live",
  "providerKycStatus": "approved",
  "submittedOn": "2026-04-22T10:34:00.000Z",
  "clientInformation": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "dob": "1815-12-10",
    "address": "27 Dorset Street, London",
    "country": "GB"
  }
}

{
  "statusCode": 404,
  "message": "KYC record not found"
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Path parameters

Returns

Error codes

​Path parameters

​Returns

​Error codes

Path parameters

Returns

Error codes