API referenceCustom watchlist

Add custom watchlist entry

POSThttps://demo-api.incodesmile.com/omni/add/watchlist/single-record

Works with Admin Token.

Headers

api-versionstringrequiredDefaults to 1.0

application/json

namestring

Name of person that is being uploaded to Watchlist

birthDatestring

Birthdate (timestamp) of person that is being uploaded to Watchlist

idNumberstring

Id number of person that is being uploaded to Watchlist

emailstring

Email of person that is being uploaded to Watchlist

phonestring

Phone of person that is being uploaded to Watchlist

personalIdNumberstring

Personal Id Number of person that is being uploaded to Watchlist

externalIdstring

External id of person that is being uploaded to Watchlist

imageBase64string

Base64 representation of face image of person that is being uploaded to Watchlist

frontIdBase64string

Base64 representation of front side of document image that is being processed to gather OCR data and uploaded to Watchlist

backIdBase64string

Base64 representation of back side of document image that is being processed to gather OCR data and uploaded to Watchlist

watchlistTypestring

Defines type of Watchlist to use

enumWHITELISTBLACKLIST

recordExpiresAtstring

Date (timestamp) until the watchlist entry is active. When searched after this date, score of watchlist match will be 0.