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

Global watchlist

Process global watchlist

This endpoint processes a global watchlist search for an individual using the watchlist configuration defined in the flow (including settings for subscription to ongoing monitoring). It performs a comprehensive screening against global watchlists (sanctions, PEPs, adverse media) and saves the results for further processing. The endpoint returns a basic success/failure response.

post/omni/process/global-watchlist

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/process/global-watchlist/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

api-versionstring required

Request body

firstNamestring

surNamestring

birthYearinteger

Year of birth, if known

subscribeboolean

Subscribes to updates on the watchlists to receive notification for updates on the search.

fuzzinessnumber float

Determines how closely the returned results must match the supplied name.

search_profilestring

Search profile set for the client to use specify what sources they will be searching against.

Response

successboolean

Flag indicating request passed successfully.

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

Session status

Changes

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