Skip to main content
POST
/
api
/
own-restricted-list
/
{listId}
/
name
addRestrictedName
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/own-restricted-list/{listId}/name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "name": "<string>",
  "comment": "<string>",
  "country": "<string>",
  "dateInfo": "2023-11-07T05:31:56Z",
  "idNumber": "<string>",
  "referenceNumber": "<string>"
}
'
{
  "comment": "<string>",
  "country": "<string>",
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "dateInfo": "2023-11-07T05:31:56Z",
  "id": 123,
  "idNumber": "<string>",
  "name": "<string>",
  "referenceNumber": "<string>",
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  }
}
This endpoint allows you to add a new name into an existing Own Restricted List (ORL).

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

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID
integer<int64>
required

X-Domain-ID

Path Parameters

listId
integer<int64>
required

listId

Body

application/json

requestDto

name
string
required
comment
string
country
string
dateInfo
string<date-time>
idNumber
string
referenceNumber
string

Response

OK

comment
string
country
string
createdAt
Timestamp · object
createdBy
UserInfo · object
dateInfo
string<date-time>
id
integer<int64>
idNumber
string
name
string
referenceNumber
string
updatedAt
Timestamp · object
updatedBy
UserInfo · object