# 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
- **Composio Managed App Available?** N/A
- **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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `method` | string ("GET" | "HEAD") | No | HTTP method to use for the health probe. Use GET to receive response body, HEAD for headers only. Defaults to GET. |
| `endpoint_path` | string | No | Endpoint path to check relative to base_url. Defaults to '/identity'. Note: The IdentityCheck API may return HTML content at some endpoints. |
| `include_raw_on_json` | boolean | No | If true and the response is JSON, include a 'raw' field in details with the original response text for debugging. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete configuration

**Slug:** `IDENTITYCHECK_DELETE_CONFIGURATION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The unique configuration code identifier used to delete the configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Unique code identifying the notification endpoint to delete (max 20 characters) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Configuration code defined by the customer when creating the configuration (max 20 chars, alphanumeric with hyphens/underscores recommended) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Notification endpoint code defined by the customer when created |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | No | Filter by specific onboarding unique identifier (returns single result if found) |
| `page` | integer | No | Zero-based page index for pagination (default is 0) |
| `dateTo` | string | No | Filter onboardings created on or before this date (yyyy-MM-dd) |
| `status` | string ("CREATED" | "CLICKED" | "CAPTURE_ONGOING" | "SUCCESS" | "EXPIRED" | "ERROR") | No | Filter by verification journey status: CREATED (link generated), CLICKED (user accessed), CAPTURE_ONGOING (actively capturing documents), SUCCESS (verified), EXPIRED (time limit exceeded), ERROR (failed) |
| `dateFrom` | string | No | Filter onboardings created on or after this date (yyyy-MM-dd) |
| `errorCode` | string ("NETWORK_ERROR" | "USER_ERROR" | "DEVICE_ERROR" | "DOCUMENT_ERROR" | "INTERNAL_ERROR") | No | Filter by error cause category (only applicable when status is ERROR): NETWORK_ERROR (connectivity issues), USER_ERROR (user abandoned/incorrect actions), DEVICE_ERROR (camera/hardware problems), DOCUMENT_ERROR (invalid/unreadable documents), INTERNAL_ERROR (system failures) |
| `businessUid` | string | No | Filter by your custom business/customer identifier (the external reference you provided when creating the onboarding) |
| `notificationType` | string ("EMAIL" | "PHONE" | "NONE") | No | Filter by delivery method of the onboarding link: EMAIL (sent via email), PHONE (sent via SMS), NONE (link generated but not automatically sent) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | UID of the onboarding |
| `docCode` | string | Yes | Code of the document to retrieve (e.g., 'passport') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Unique identifier (UID) of the onboarding session to retrieve. Obtain this from the response when creating an onboarding or from the IDENTITYCHECK_FETCH_ONBOARDINGS action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Configuration code defined by the customer |
| `configuration` | object | Yes | Configuration payload |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |