---
title: "Add custom watchlist entry"
method: POST
path: "/omni/add/watchlist/single-record"
tags: ["Custom watchlist"]
---

# Add custom watchlist entry

`POST /omni/add/watchlist/single-record`

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

## Headers

- `api-version` string, required

## Request body

- InsertWatchlistRequest
  - `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
  - `email` 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` 'WHITELIST' | 'BLACKLIST' — Defines type of Watchlist to use
  - `recordExpiresAt` string — Date (timestamp) until the watchlist entry is active. When searched after this date, score of watchlist match will be 0.

## Response `200`

OK

- AddSingleWatchlistResponse
  - `success` boolean — Flag indicating request passed successfully.
  - `sessionStatus` 'Alive' | 'Closed' | 'Deleted' — Session status
  - `customerId` string
  - `watchlistId` string

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/incode/apis/incode-omni-api.md) · [All operations](https://skmtc.dev/incode/apis/incode-omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/incode/incode-omni-api/revisions/30cd6d926ea3/schema)
