Add custom watchlist entry

post

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

Works with Admin Token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Values of idNumber, email, phone,imageBase64 must be unique. These fields are used to perform search in watchlist database. At least one of these must be supplied.

name

string

Name of person that is being uploaded to Watchlist

birthDate

string

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

idNumber

string

Id number of person that is being uploaded to Watchlist

string

Email of person that is being uploaded to Watchlist

phone

string

Phone of person that is being uploaded to Watchlist

personalIdNumber

string

Personal Id Number of person that is being uploaded to Watchlist

imageBase64

string

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

frontIdBase64

string

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

backIdBase64

string

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

watchlistType

string

enum

Defines type of Watchlist to use

Allowed:

recordExpiresAt

string

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

Headers

api-version

string

required

Defaults to 1.0

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request