Antifraud1

API validations3

Authentications1

Curp validation2

Custom fields2

Custom watchlist5

Document capture6

Electronic signature3

Electronic signature advanced1

Email input2

Face capture3

Fiscal qr url3

Forms and data entry1

Geolocation1

Global watchlist3

Government validation1

Id capture16

Identities1

Interview32

Nom1514

Onboarding1

Organization4

Phone number input4

Proof of address capture2

Shared consent2

User consent2

Video conference5

Videoselfie2

Custom watchlist

Add custom watchlist entry

Works with <Glossary>Admin Token</Glossary>.

post/omni/add/watchlist/single-record

Request

Base URL
https://demo-api.incodesmile.com
Auth
API key in header x-api-key and API key in header X-Incode-Hardware-Id
TypeScript
https://skmtc.dev/incode/apis/incode-omni-api/docs/omni/add/watchlist/single-record/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

api-versionstring required

Request body

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

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

watchlistType'WHITELIST' | 'BLACKLIST'

Defines type of Watchlist to use

recordExpiresAtstring

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

Response

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status

customerIdstring

watchlistIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.