List Identity Checks
Returns identity check requests for the authenticated customer. These are verification requests (e.g. ID upload, KYC) that the operator has configured as part of the onboarding or compliance process.
Authentication
Requires a valid customer bearer token.
Query Parameters
true — return only pending/incomplete checks. false — return all checks including completed ones.
Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation.
Response
Returns an IdentityChecksList object — a paginated list of identity check records.
Identity Check Fields
Identity
| Field | Type | Description |
|---|
Id | number | Unique numeric identifier for the identity check |
Core
| Field | Type | Description |
|---|
Name | string | Check display name |
Description | string | Check description |
Notes | string | Additional notes |
VerificationType | string | Type of verification (e.g. Identity, Address) |
IdentityCheckProvider | string | Provider used for the check |
VerificationStatus | string | Current status (Pending, Verified, etc.) |
LastError | string | Last error message (if any) |
| Field | Type | Description |
|---|
ContactId | number | Contact identifier |
ContactFullName | string | Contact full name |
BusinessId | number | Location identifier |
BusinessName | string | Location display name |
Documents
| Field | Type | Description |
|---|
IdentityDocumentType | string | Type of identity document |
IdentityDocumentIssuedBy | string | Issuing authority |
IdentityDocumentExpirationDate | string | null | Document expiration date |
AddressDocumentType | string | Type of address document |
Timestamps
| Field | Type | Description |
|---|
CreatedOnUtc | string | Date created (UTC) |
Examples
Fetch pending checks
GET /api/public/identityChecks/my?showPending=true
Authorization: Bearer {token}
TypeScript Integration
import endpoints from '@/api/endpoints'
const { resource: checks } = useTypedData(httpClient, endpoints.identity.list(true))
