Identitycheck | Composio Docs

Overview

SLUG: IDENTITYCHECK

Description

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.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Identitycheck

Create an auth config

Use the dashboard to create an auth config for the Identitycheck toolkit. This allows you to connect multiple Identitycheck accounts to Composio for agents to use.

Select App

Navigate to Identitycheck.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Identitycheck Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 identitycheck_auth_config_id = "ac_YOUR_IDENTITYCHECK_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Identitycheck for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, identitycheck_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Identitycheck toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["IDENTITYCHECK"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

IDENTITYCHECK_CHECK_API_HEALTH

Tool Name: Check API Health

Description

Tool to perform API health check. Use to verify API availability before other operations.

Action Parameters

endpoint_path

string

include_raw_on_json

boolean

method

stringDefaults to GET

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_DELETE_CONFIGURATION

Tool Name: Delete configuration

Description

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

Action Parameters

code

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINT

Tool Name: Delete Notification Endpoint

Description

Tool to delete a notification endpoint. Use after confirming the endpoint code exists and you need to remove it.

Action Parameters

code

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_FETCH_ALL_CONFIGURATIONS

Tool Name: Fetch All Configurations

Description

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

Action Parameters

Action Response

data

arrayRequired

error

string

successful

booleanRequired

IDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTS

Tool Name: Fetch all notification endpoints

Description

Tool to fetch all notification endpoints. Use when you need to list all existing notification endpoints.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_FETCH_CONFIGURATION

Tool Name: Fetch Configuration

Description

Tool to fetch a configuration by its code. Use when you need detailed settings of a specific identity check configuration.

Action Parameters

code

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINT

Tool Name: Fetch Notification Endpoint

Description

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

Action Parameters

code

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_FETCH_ONBOARDINGS

Tool Name: Fetch Onboardings

Description

Tool to retrieve onboardings. Use when you need to list onboardings with filters like UID, status, date range, etc. Example: List onboardings created since 2023-01-01 with status SUCCESS

Action Parameters

businessUid

string

dateFrom

string

dateTo

string

errorCode

string

notificationType

string

page

integer

status

string

uid

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_GET_DOCUMENT_CONTENT

Tool Name: Get Document Content

Description

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

Action Parameters

docCode

stringRequired

uid

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_RETRIEVE_ONBOARDING_STATUS

Tool Name: Retrieve Onboarding Status

Description

Tool to retrieve the status of an onboarding. Use after creating an onboarding to check its progress and final result.

Action Parameters

uid

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

IDENTITYCHECK_UPDATE_CONFIGURATION

Tool Name: Update Configuration

Description

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

Action Parameters

code

stringRequired

configuration

objectRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired