Watchlist Activity Parameters

Watchlist Search Activities

Search Document Number v1

Early Access


Perform a search against a Watchlist to identify potential matches using a document number.

Parameter Description Type Default
Document Key The key used to identify the document to be searched. String doc1
Document Number Document number to search for (max 100 chars). This will be filled automatically if Document Key is provided. String
Document Type Document type (max 250 chars, e.g., Austria - Id Card (2021), Serbia - Id Card (2009-2014) #1) String ${_idDocs.doc1.currentCapture.extractedText.documentInfo.type}
Max Match Results Maximum number of matches to return (1-100) Integer ${10}
Search Behavior Determines how match results are interpreted: BLOCK (match=FAIL, no match=PASS), ALLOW (match=PASS, no match=FAIL), BLOCK_REVIEW (match=REVIEW, no match=PASS), ALLOW_REVIEW (match=REVIEW, no match=FAIL) String BLOCK
Search Key The key under which the check result will be stored in the checks object String watchlistSearch1
Watchlist Name Name of the document watchlist (max 250 chars) String

Search FaceV6 Watchlist v1

Early Access


Perform a search against a Watchlist to identify potential matches using a face image and FaceV6 algorithm.

Parameter Description Type Default
Face Key Key identifying the face to be searched. String face1
Match Threshold (Score) Similarity score threshold for matches (0.0 to 1.0). Higher values require stronger similarity. Double ${0.205245}
Max Match Results Maximum number of matches to return (1-100, capped at 100) Integer ${10}
Search Behavior Determines how match results are interpreted: BLOCK (match=FAIL, no match=PASS), ALLOW (match=PASS, no match=FAIL), BLOCK_REVIEW (match=REVIEW, no match=PASS), ALLOW_REVIEW (match=REVIEW, no match=FAIL) String BLOCK
Search Key The key under which the check result will be stored in the checks object String watchlistSearch1
Watchlist Name Name of the watchlist to search (max 250 chars) String

Search IPv4 Watchlist v1

Early Access


Perform a search against a Watchlist to identify potential matches using an IPv4 address.

Parameter Description Type Default
IPv4 Address IPv4 address to search (max 18 chars, e.g., "192.168.1.1") String ${_signals.ipv4s.ipv4Address1.ipv4}
Max Match Results Maximum number of matches to return (1-100) Integer ${10}
Search Behavior Determines how match results are interpreted: BLOCK (match=FAIL, no match=PASS), ALLOW (match=PASS, no match=FAIL), BLOCK_REVIEW (match=REVIEW, no match=PASS), ALLOW_REVIEW (match=REVIEW, no match=FAIL) String BLOCK
Search Key The key under which the check result will be stored in the checks object String watchlistSearch1
Watchlist Name Name of the IPv4 watchlist (max 250 chars) String Name of the IPv4 watchlist (max 250 chars)

Search VisitorID Watchlist v1

Early Access


Perform a search against a Watchlist to identify potential matches using a visitor ID address.

Parameter Description Type Default
Max Match Results Maximum number of matches to return (1-100) Integer ${10}
Search Behavior Determines how match results are interpreted: BLOCK (match=FAIL, no match=PASS), ALLOW (match=PASS, no match=FAIL), BLOCK_REVIEW (match=REVIEW, no match=PASS), ALLOW_REVIEW (match=REVIEW, no match=FAIL) String BLOCK
Search Key The key under which the check result will be stored in the checks object String watchlistSearch1
Visitor ID Unique device/browser fingerprint identifier (max 100 chars) String
Watchlist Name Name of the visitor ID watchlist (max 250 chars) String

Search Email Watchlist v1

Early Access


Perform a search against a Watchlist to identify potential matches using an email address.

Parameter Description Type Default
E-mail Address Email address to search the Watchlist (max 254 chars, valid email format). String
Max Match Results Maximum number of matches to return (1-100) Integer ${10}
Normalize Whether to normalize the phone number before searching. Boolean ${true}
Search Behavior Determines how match results are interpreted: BLOCK (match=FAIL, no match=PASS), ALLOW (match=PASS, no match=FAIL), BLOCK_REVIEW (match=REVIEW, no match=PASS), ALLOW_REVIEW (match=REVIEW, no match=FAIL) String BLOCK
Search Key The key under which the check result will be stored in the checks object String watchlistSearch1
Watchlist Name Name of the email address watchlist (max 250 chars) String

Search Phone Number Watchlist v1

Early Access


Perform a search against a Watchlist to identify potential matches using an phone number.

Parameter Description Type Default
Max Match Results Maximum number of matches to return (1-100) Integer ${10}
Normalize Whether to normalize the phone number before searching. Boolean ${true}
Phone Number Phone number to search for in the Watchlist (max 24 chars). String
Region Optional region code for phone number normalization. A maximum of 2 characters is supported. String
Search Behavior Determines how match results are interpreted: BLOCK (match=FAIL, no match=PASS), ALLOW (match=PASS, no match=FAIL), BLOCK_REVIEW (match=REVIEW, no match=PASS), ALLOW_REVIEW (match=REVIEW, no match=FAIL) String BLOCK
Search Key The key under which the check result will be stored in the checks object String watchlistSearch1
Watchlist Name Name of the phone number watchlist (max 250 chars) String

Watchlist Add Activities

Add Document Number Watchlist Entry v1

Early Access


Add POI from a document number to a Document Number Watchlist.

Parameter Description Type Default
Document Key Key that can be used to identify the document during search. String doc1
Document Number Document number to add (max 100 chars). If not provided, docKey must be provided. String
Document Type Document type (max 250 chars, e.g., Austria - Id Card (2021), Serbia - Id Card (2009-2014) #1). If not provided, docKey must be provided. String ${_idDocs.doc1.currentCapture.extractedText.documentInfo.type}
Expire After ISO 8601 duration after which the entry will be automatically deleted (e.g., PT1H, P1D). Converted to UTC timestamp by the activity. String
Note An optional note. When provided, the note is stored with the watchlist entry and is visible in the activity history, enabling better context and traceability when reviewing watchlist matches. String
Watchlist Name Name of the watchlist where the entry will be added String

Add FaceV6 Watchlist Entry v1

Early Access


Parameter Description Type Default
Email The email address associated with the POI. By default, this will be set to the email address of the Process Token email parameter. String ${_initVars.params.email}
Expire After When the POI will expire and be removed from the Watchlist. String
External ID External system identifier String ${_initVars.params.externalId}
Face Key Key identifying the face image to add String face1
First Name The first name of the POI. By default, this will be set as the Process Token first name parameter. String ${_initVars.params.firstName}
Full Name The full name of the POI. String
Last Name The last name of the POI. By default, this will be set as the Process Token last name parameter. String ${_initVars.params.lastName}
Note An optional note. When provided, the note is stored with the watchlist entry and is visible in the activity history, enabling better context and traceability when reviewing watchlist matches. String
Phone Number The phone number of the POI. By default, this will be set as the Process Token phone number parameter. String ${_initVars.params.phoneNumber}
Store Face Image If enabled, the captured face image will be stored in TrustX. String ${true}
Watchlist Name Name of the watchlist where the entry will be added String

Add IPv4 Watchlist Entry v1

Early Access


Add POI from an IPv4 address to an IPv4 Watchlist.

Parameter Description Type Default
Expire After ISO 8601 duration after which the entry will be automatically deleted (e.g., PT1H, P1D). Converted to UTC timestamp by the activity. String
IPv4 Address IPv4 address (max 15 chars, e.g., "192.168.100.100"). We will not support CIDR ranges at this time. String ${_signals.ipv4s.ipv4Address1.ipv4}
Note An optional note. When provided, the note is stored with the watchlist entry and is visible in the activity history, enabling better context and traceability when reviewing watchlist matches. String
Watchlist Name The name of the IPv4 Watchlist that the entry will be added to. String

Add Visitor ID Watchlist Entry v1

Early Access


Add POI from a Visitor ID to a Visitor ID Watchlist.

Parameter Description Type Default
Expire After ISO 8601 duration after which the entry will be automatically deleted (e.g., PT1H, P1D). Converted to UTC timestamp by the activity. Date-Time
Note An optional note. When provided, the note is stored with the watchlist entry and is visible in the activity history, enabling better context and traceability when reviewing watchlist matches. String
Visitor ID Unique device/browser fingerprint (max 100 chars) String
Watchlist Name The name of the Watchlist to be added. String

Add Email Watchlist Entry v1

Early Access


Parameter Description Type Default
E-mail Address Email address to add to the Watchlist (max 254 chars, valid email format). String
Expire After ISO 8601 duration after which the entry will be automatically deleted (e.g., PT1H, P1D). Converted to UTC timestamp by the activity. Date-Time
Normalize Whether to normalize the email address before adding. Boolean ${true}
Note An optional note. When provided, the note is stored with the watchlist entry and is visible in the activity history, enabling better context and traceability when reviewing watchlist matches. String
Watchlist Name The name of the Watchlist to be added. String

Add Phone Number Watchlist Entry v1

Early Access


Parameter Description Type Default
Expire After ISO 8601 duration after which the entry will be automatically deleted (e.g., PT1H, P1D). Converted to UTC timestamp by the activity. Date-Time
Normalize Whether to normalize the phone number before adding. Boolean ${true}
Note An optional note. When provided, the note is stored with the watchlist entry and is visible in the activity history, enabling better context and traceability when reviewing watchlist matches. String
Phone Number Phone number to be added to the Watchlist (max 24 chars). String
Region Optional region code for phone number normalization. A maximum of 2 characters is supported. String
Watchlist Name The name of the Watchlist to be added. String

Record IPv4 Address v1

Early Access


Parameter Description Type Default
Key The identifier associated with the activity. String ipv4Address1


Next to read:
OIDC Integration
null
On This Page
Watchlist Activity ParametersWatchlist Search ActivitiesWatchlist Add ActivitiesSearch Document Number v1Search FaceV6 Watchlist v1Search IPv4 Watchlist v1Search VisitorID Watchlist v1Search Email Watchlist v1Search Phone Number Watchlist v1Add Document Number Watchlist Entry v1Add FaceV6 Watchlist Entry v1Add IPv4 Watchlist Entry v1Add Visitor ID Watchlist Entry v1Add Email Watchlist Entry v1Add Phone Number Watchlist Entry v1Record IPv4 Address v1