addRestrictedName
Own Restricted List APIs
Post Name into Restricted List
POST
addRestrictedName
This endpoint allows you to add a new name into an existing Own Restricted List (ORL).Documentation Index
Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt
Use this file to discover all available pages before exploring further.
Path Parameters
listId— The unique identifier of the restricted list where the name will be added.
Request Body
name(required) — The name to be added into the restricted list.country(optional) — Country associated with the restricted name.referenceNumber(optional) — Reference number for internal tracking.idNumber(optional) — Identification number of the restricted individual/entity.comment(optional) — Additional notes or remarks about this entry.active(optional) — Boolean flag to mark the entry as active (true) or inactive (false).
Notes
- The name field is mandatory.
- This API supports adding additional metadata (like country, reference number, or ID number) to strengthen matching precision.
- Once added, the name will be included in all screenings against the specified restricted list.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
X-Domain-ID
Path Parameters
listId
Body
application/json
requestDto
