Identitycheck
identitycheckIdentityCheck 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.
Acciones disponibles (11)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Check API HealthIDENTITYCHECK_CHECK_API_HEALTHAcciónTool to perform API health check. Use to verify API availability before other operations.
IDENTITYCHECK_CHECK_API_HEALTHAcciónTool to perform API health check. Use to verify API availability before other operations.
Parámetros de entrada
methodstringenumHTTP method to use for the health probe. Defaults to GET.
GETHEADendpoint_pathstringEndpoint path to call relative to base_url (e.g., '/identity' or 'monitoring/health'). Defaults to '/identity'
include_raw_on_jsonbooleanIf true and the response is JSON, include a 'raw' field in details with the original text.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete configurationIDENTITYCHECK_DELETE_CONFIGURATIONAcciónTool to delete an existing configuration. Use when you need to remove a configuration by its unique code.
IDENTITYCHECK_DELETE_CONFIGURATIONAcciónTool to delete an existing configuration. Use when you need to remove a configuration by its unique code.
Parámetros de entrada
codestringObligatorioConfiguration code defined by the customer when it created the configuration.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Notification EndpointIDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINTAcciónTool to delete a notification endpoint. Use after confirming the endpoint code exists and you need to remove it.
IDENTITYCHECK_DELETE_NOTIFICATION_ENDPOINTAcciónTool to delete a notification endpoint. Use after confirming the endpoint code exists and you need to remove it.
Parámetros de entrada
codestringObligatorioUnique code of the notification endpoint to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch All ConfigurationsIDENTITYCHECK_FETCH_ALL_CONFIGURATIONSAcciónTool to fetch all existing configurations. Use when you need to list all customer configurations after authentication.
IDENTITYCHECK_FETCH_ALL_CONFIGURATIONSAcciónTool to fetch all existing configurations. Use when you need to list all customer configurations after authentication.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch all notification endpointsIDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTSAcciónTool to fetch all notification endpoints. Use when you need to list all existing notification endpoints.
IDENTITYCHECK_FETCH_ALL_NOTIFICATION_ENDPOINTSAcciónTool to fetch all notification endpoints. Use when you need to list all existing notification endpoints.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch ConfigurationIDENTITYCHECK_FETCH_CONFIGURATIONAcciónTool to fetch a configuration by its code. Use when you need detailed settings of a specific identity check configuration.
IDENTITYCHECK_FETCH_CONFIGURATIONAcciónTool to fetch a configuration by its code. Use when you need detailed settings of a specific identity check configuration.
Parámetros de entrada
codestringObligatorioConfiguration code defined by the customer when creating the configuration
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Notification EndpointIDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINTAcciónTool to fetch a notification endpoint by its code. Use when you need the current configuration of a specific callback endpoint.
IDENTITYCHECK_FETCH_NOTIFICATION_ENDPOINTAcciónTool to fetch a notification endpoint by its code. Use when you need the current configuration of a specific callback endpoint.
Parámetros de entrada
codestringObligatorioNotification endpoint code defined by the customer when created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch OnboardingsIDENTITYCHECK_FETCH_ONBOARDINGSAcciónTool 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
IDENTITYCHECK_FETCH_ONBOARDINGSAcciónTool 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
Parámetros de entrada
uidstringFilter by onboarding UID
pageintegerZero-based page index for pagination (default is 0)
dateTostringdateFilter onboardings created on or before this date (yyyy-MM-dd)
statusstringenumFilter by onboarding status
CREATEDCLICKEDCAPTURE_ONGOINGSUCCESSEXPIREDERRORdateFromstringdateFilter onboardings created on or after this date (yyyy-MM-dd)
errorCodestringenumFilter by onboarding error code
NETWORK_ERRORUSER_ERRORDEVICE_ERRORDOCUMENT_ERRORINTERNAL_ERRORbusinessUidstringFilter by your business-specific UID
notificationTypestringenumFilter by notification type used to send the link
EMAILPHONENONE
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Document ContentIDENTITYCHECK_GET_DOCUMENT_CONTENTAcciónTool to retrieve base64-encoded document content. Use when you have an onboarding UID and document code.
IDENTITYCHECK_GET_DOCUMENT_CONTENTAcciónTool to retrieve base64-encoded document content. Use when you have an onboarding UID and document code.
Parámetros de entrada
uidstringObligatorioUID of the onboarding
docCodestringObligatorioCode of the document to retrieve (e.g., 'passport')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Onboarding StatusIDENTITYCHECK_RETRIEVE_ONBOARDING_STATUSAcciónTool to retrieve the status of an onboarding. Use after creating an onboarding to check its progress and final result.
IDENTITYCHECK_RETRIEVE_ONBOARDING_STATUSAcciónTool to retrieve the status of an onboarding. Use after creating an onboarding to check its progress and final result.
Parámetros de entrada
uidstringObligatorioUnique identifier of the onboarding
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ConfigurationIDENTITYCHECK_UPDATE_CONFIGURATIONAcciónTool to update an existing configuration. Use when you need to modify properties of a configuration identified by code.
IDENTITYCHECK_UPDATE_CONFIGURATIONAcciónTool to update an existing configuration. Use when you need to modify properties of a configuration identified by code.
Parámetros de entrada
codestringObligatorioConfiguration code defined by the customer
configurationobjectObligatorioConfiguration payload
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not