Skip to main content
GET
getRestrictedNames
This endpoint retrieves all the restricted names inside a specific Own Restricted List (ORL).

Path Parameters

  • listId — The unique identifier of the restricted list whose entries you want to retrieve.

Description

  • Returns all names that belong to the given restricted list.
  • Each entry may include:
    • id — Unique identifier of the entry.
    • name — Name added into the restricted list.
    • country — Country associated with the name (if provided).
    • referenceNumber — Internal reference number (optional).
    • idNumber — Identification number (optional).
    • comment — Notes or remarks (optional).
    • active — Boolean flag showing if the entry is currently active.

Notes

  • Use Get All Restricted List first to identify the listId.
  • This API is useful for managing and reviewing restricted list contents.
  • Inactive entries (active: false) will still appear in the results but are excluded from screenings.

Authorizations

Authorization
string
header
required

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

FlowClient Credentials
Token URL
https://crm.cynopsis.co/oauth/token

Headers

X-Domain-ID
integer<int64>
required

X-Domain-ID

Path Parameters

listId
integer<int64>
required

listId

Query Parameters

offset
integer<int64>
paged
boolean
pageNumber
integer<int32>
pageSize
integer<int32>
sort.sorted
boolean
sort.unsorted
boolean
unpaged
boolean

Response

OK

content
RestrictedNameResponseDto · object[]
empty
boolean
first
boolean
last
boolean
number
integer<int32>
numberOfElements
integer<int32>
pageable
Pageable · object
size
integer<int32>
sort
Sort · object
totalElements
integer<int64>
totalPages
integer<int32>