NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Identitycheck connects to a Nagent workspace with an API key. Once it is connected, agents can call 11 Identitycheck actions, such as "Get Document Content", "Update Configuration" and "Check API Health". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Identitycheck, with input parameters and output schema.
IDENTITYCHECK_CHECK_API_HEALTHPerforms 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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_DELETE_CONFIGURATIONTool to delete an existing configuration. Use when you need to remove a configuration by its unique code.
Input parameters
The unique configuration code identifier used to delete the configuration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINTTool 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
Unique code identifying the notification endpoint to delete (max 20 characters)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_FETCH_ALL_CONFIGURATIONSTool to fetch all existing configurations. Use when you need to list all customer configurations after authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTSFetches 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_FETCH_CONFIGURATIONFetch 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
Configuration code defined by the customer when creating the configuration (max 20 chars, alphanumeric with hyphens/underscores recommended)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINTTool to fetch a notification endpoint by its code. Use when you need the current configuration of a specific callback endpoint.
Input parameters
Notification endpoint code defined by the customer when created
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_FETCH_ONBOARDINGSRetrieves 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
Filter by specific onboarding unique identifier (returns single result if found)
Zero-based page index for pagination (default is 0)
Filter onboardings created on or before this date (yyyy-MM-dd)
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 onboardings created on or after this date (yyyy-MM-dd)
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_GET_DOCUMENT_CONTENTTool to retrieve base64-encoded document content. Use when you have an onboarding UID and document code.
Input parameters
UID of the onboarding
Code of the document to retrieve (e.g., 'passport')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_RETRIEVE_ONBOARDING_STATUSRetrieve 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
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IDENTITYCHECK_UPDATE_CONFIGURATIONTool to update an existing configuration. Use when you need to modify properties of a configuration identified by code.
Input parameters
Configuration code defined by the customer
Configuration payload
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 11 Identitycheck actions on Nagent, including "Get Document Content", "Update Configuration" and "Check API Health". Get Document Content: Retrieve base64-encoded document content. Each action is listed on this page with its input parameters and its output.
Identitycheck connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Document Content takes 2 required inputs: uid and docCode. It returns data, error and successful.