- Category: security & identity tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 11
- Triggers: 0
- Slug:
IDENTITYCHECK - Version: 20261101_00
Tools
Check API Health
Check API Health
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
HTTP method to use for the health probe. Use GET to receive response body, HEAD for headers only. Defaults to GET.
Endpoint path to check relative to base_url. Defaults to ‘/identity’. Note: The IdentityCheck API may return HTML content at some endpoints.
If true and the response is JSON, include a ‘raw’ field in details with the original response text for debugging.
Output
Delete configuration
Delete configuration
Delete Notification Endpoint
Delete Notification Endpoint
Fetch All Configurations
Fetch All Configurations
Fetch all notification endpoints
Fetch all notification endpoints
Fetch Configuration
Fetch Configuration
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
Configuration code defined by the customer when creating the configuration (max 20 chars, alphanumeric with hyphens/underscores recommended)
Output
Fetch Notification Endpoint
Fetch Notification Endpoint
Fetch Onboardings
Fetch Onboardings
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
Filter by verification journey status: CREATED (link generated), CLICKED (user accessed), CAPTURE_ONGOING (actively capturing documents), SUCCESS (verified), EXPIRED (time limit exceeded), ERROR (failed)
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)
Filter by your custom business/customer identifier (the external reference you provided when creating the onboarding)
Filter by delivery method of the onboarding link: EMAIL (sent via email), PHONE (sent via SMS), NONE (link generated but not automatically sent)
Output
Get Document Content
Get Document Content
Retrieve Onboarding Status
Retrieve Onboarding Status
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
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.