# Identitycheck

IdentityCheck is a verification solution designed to authenticate user identities with precision and speed, utilizing advanced algorithms and comprehensive data sources to ensure accurate validation, mitigate fraud, and enhance security.

- **Category:** security & identity tools
- **Auth:** API_KEY
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `IDENTITYCHECK`
- **Version:** 20260203_00

## Tools

### Check API Health

**Slug:** `IDENTITYCHECK_CHECK_API_HEALTH`

Performs an API health check to verify endpoint availability and responsiveness. This tool sends an HTTP request to a specified endpoint and interprets a 200 OK response as indicating the API is UP. It handles both JSON and non-JSON responses (including HTML). Use this before other operations to confirm the API is reachable.

### Delete configuration

**Slug:** `IDENTITYCHECK_DELETE_CONFIGURATION`

Tool to delete an existing configuration. Use when you need to remove a configuration by its unique code.

### Delete Notification Endpoint

**Slug:** `IDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINT`

Tool to delete a notification endpoint by its unique code. This operation is idempotent - it will succeed whether the endpoint exists or has already been deleted. Use when you need to remove a callback endpoint that receives webhook notifications for identity verification events.

### Fetch All Configurations

**Slug:** `IDENTITYCHECK_FETCH_ALL_CONFIGURATIONS`

Tool to fetch all existing configurations. Use when you need to list all customer configurations after authentication.

### Fetch all notification endpoints

**Slug:** `IDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTS`

Fetches all configured notification endpoints (webhooks) for the IdentityCheck SDK. Use this to list all callback URLs that receive onboarding event notifications (START_ONBOARDING, END_ONBOARDING).

### Fetch Configuration

**Slug:** `IDENTITYCHECK_FETCH_CONFIGURATION`

Fetch a specific identity verification configuration by its code. Use this action when you need to: - Retrieve theme customizations (logo, colors, button styles) for a configuration - Get custom wordings/translations defined for different languages - Review configuration options like link validity, email sender name, or ID capture settings - Verify that a configuration exists before using it in an onboarding flow The configuration code is the unique identifier assigned when the configuration was created.

### Fetch Notification Endpoint

**Slug:** `IDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINT`

Tool to fetch a notification endpoint by its code. Use when you need the current configuration of a specific callback endpoint.

### Fetch Onboardings

**Slug:** `IDENTITYCHECK_FETCH_ONBOARDINGS`

Retrieves identity verification onboarding sessions with comprehensive filtering and pagination. An onboarding represents a customer's identity verification journey, tracking their progress from link creation through document capture and verification completion. Each onboarding has a unique link sent via email/phone/none, and transitions through states: CREATED → CLICKED → CAPTURE_ONGOING → SUCCESS/ERROR/EXPIRED. Use this to: - Monitor verification sessions by status, date range, or customer identifiers - Track onboarding completion rates and error patterns - Retrieve specific onboardings by UID or business-specific identifiers - Analyze notification delivery methods and their effectiveness Returns paginated results with statistics (total results, distinct users, captures per document). All filter parameters are optional; omit them to retrieve all onboardings. Example: Find all failed verifications due to network errors in January 2024

### Get Document Content

**Slug:** `IDENTITYCHECK_GET_DOCUMENT_CONTENT`

Tool to retrieve base64-encoded document content. Use when you have an onboarding UID and document code.

### Retrieve Onboarding Status

**Slug:** `IDENTITYCHECK_RETRIEVE_ONBOARDING_STATUS`

Retrieve the current status and results of an identity verification onboarding session. Use this tool to check the progress of an onboarding (CREATED, CLICKED, CAPTURE_ONGOING) or get final results (SUCCESS, ERROR, EXPIRED). Returns detailed analysis results, error causes, and CIS export data when available.

### Update Configuration

**Slug:** `IDENTITYCHECK_UPDATE_CONFIGURATION`

Tool to update an existing configuration. Use when you need to modify properties of a configuration identified by code.
