Skip to main content
Identitycheck logo
  • Category: security & identity tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: IDENTITYCHECK
  • Version: 20261101_00

Tools

Slug: IDENTITYCHECK_CHECK_API_HEALTHChecks 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_DELETE_CONFIGURATIONDeletes 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

string
required
The unique configuration code identifier used to delete the configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINTDeletes 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

string
required
Unique code identifying the notification endpoint to delete (max 20 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_FETCH_ALL_CONFIGURATIONSFetch all customer identity verification configurations for the authenticated account. Use this to review the available configurations and their settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTSFetch all configured notification endpoints for the IdentityCheck SDK. Use this to list callback URLs subscribed to onboarding start and end events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_FETCH_CONFIGURATIONFetch 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

string
required
Configuration code defined by the customer when creating the configuration (max 20 chars, alphanumeric with hyphens/underscores recommended)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINTFetch 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

string
required
Notification endpoint code defined by the customer when created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_FETCH_ONBOARDINGSRetrieve 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

string
Filter by specific onboarding unique identifier (returns single result if found)
integer
Zero-based page index for pagination (default is 0)
string
Filter onboardings created on or before this date (yyyy-MM-dd)
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)
string
Filter onboardings created on or after this date (yyyy-MM-dd)
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)
string
Filter by your custom business/customer identifier (the external reference you provided when creating the onboarding)
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_GET_DOCUMENT_CONTENTTool to retrieve base64-encoded document content. Use when you have an onboarding UID and document code.

Input Parameters

string
required
UID of the onboarding
string
required
Code of the document to retrieve (e.g., ‘passport’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_RETRIEVE_ONBOARDING_STATUSRetrieve 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IDENTITYCHECK_UPDATE_CONFIGURATIONUpdates 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

string
required
Configuration code defined by the customer
object
required
Configuration payload

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not