> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

![Identitycheck logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/identitycheck.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=e03d77fb843824b77aa1e836e81a3515)

* **Category:** security & identity tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 11
* **Triggers:** 0
* **Slug:** `IDENTITYCHECK`
* **Version:** 20261101\_00

## Tools

> [accordion] Check API Health
>
> **Slug:** `IDENTITYCHECK_CHECK_API_HEALTH`
>
> Checks an endpoint's availability using GET or HEAD. A 200 response is treated as UP unless a JSON response supplies an explicit status; non-200 responses raise an error.
>
> #### Input Parameters
>
> **method** `string ("GET" | "HEAD")`
>
> HTTP method to use for the health probe. Use GET to receive response body, HEAD for headers only. Defaults to GET.
>
> **endpoint\_path** `string`
>
> 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`
>
> If true and the response is JSON, include a 'raw' field in details with the original response text for debugging.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete configuration
>
> **Slug:** `IDENTITYCHECK_DELETE_CONFIGURATION`
>
> Deletes a configuration by its code. A reported success can also follow a 404 on any candidate path, so it does not necessarily confirm deletion.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> The unique configuration code identifier used to delete the configuration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Notification Endpoint
>
> **Slug:** `IDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINT`
>
> Deletes a notification endpoint by its code. A reported success can also follow a 404 on any candidate path, so it does not necessarily confirm deletion.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Unique code identifying the notification endpoint to delete (max 20 characters)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch All Configurations
>
> **Slug:** `IDENTITYCHECK_FETCH_ALL_CONFIGURATIONS`
>
> Fetch all customer identity verification configurations for the authenticated account. Use this to review the available configurations and their settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch all notification endpoints
>
> **Slug:** `IDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTS`
>
> Fetch all configured notification endpoints for the IdentityCheck SDK. Use this to list callback URLs subscribed to onboarding start and end events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Configuration
>
> **Slug:** `IDENTITYCHECK_FETCH_CONFIGURATION`
>
> Fetch an identity verification configuration by its customer-defined code. Use it to review its theme, language-specific wording and options such as link validity, email sender name and ID capture settings.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Configuration code defined by the customer when creating the configuration (max 20 chars, alphanumeric with hyphens/underscores recommended)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Notification Endpoint
>
> **Slug:** `IDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINT`
>
> Fetch a notification endpoint by its customer-defined code to review the configuration of a specific onboarding callback, including its URL and subscribed events.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Notification endpoint code defined by the customer when created
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Onboardings
>
> **Slug:** `IDENTITYCHECK_FETCH_ONBOARDINGS`
>
> Retrieve paginated identity verification onboarding sessions to monitor progress and analyze outcomes. Filter optionally by session or business identifier, status, error category, creation dates or notification method; results include summary statistics and page information.
>
> #### Input Parameters
>
> **uid** `string`
>
> Filter by specific onboarding unique identifier (returns single result if found)
>
> **page** `integer`
>
> Zero-based page index for pagination (default is 0)
>
> **dateTo** `string`
>
> Filter onboardings created on or before this date (yyyy-MM-dd)
>
> **status** `string ("CREATED" | "CLICKED" | "CAPTURE_ONGOING" | "SUCCESS" | "EXPIRED" | "ERROR")`
>
> 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`
>
> Filter onboardings created on or after this date (yyyy-MM-dd)
>
> **errorCode** `string ("NETWORK_ERROR" | "USER_ERROR" | "DEVICE_ERROR" | "DOCUMENT_ERROR" | "INTERNAL_ERROR")`
>
> 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`
>
> Filter by your custom business/customer identifier (the external reference you provided when creating the onboarding)
>
> **notificationType** `string ("EMAIL" | "PHONE" | "NONE")`
>
> Filter by delivery method of the onboarding link: EMAIL (sent via email), PHONE (sent via SMS), NONE (link generated but not automatically sent)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **uid** `string` *required*
>
> UID of the onboarding
>
> **docCode** `string` *required*
>
> Code of the document to retrieve (e.g., 'passport')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Onboarding Status
>
> **Slug:** `IDENTITYCHECK_RETRIEVE_ONBOARDING_STATUS`
>
> Retrieve the status and available results of an identity verification onboarding session by UID. Use it to check progress or review final analysis results, error causes and CIS export data when available.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Configuration
>
> **Slug:** `IDENTITYCHECK_UPDATE_CONFIGURATION`
>
> Updates a configuration identified by code, with a create-capable fallback. It may return configuration data based on the supplied payload even when a write is not confirmed.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Configuration code defined by the customer
>
> **configuration** `object` *required*
>
> Configuration payload
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
