List watchlist screening results

GET 
/WatchListScreening

List watchlist screening results

Request

Query Parameters

customerCode string

The unique code of the customer to retrieve screening results for.

pageOptions.page int32

Possible values: >= 1 and <= 2147483647

The 1-based page number for paginated results.

pageOptions.count int32

Possible values: >= 1 and <= 50

The number of items to return per page (1–50).

pageOptions.sortByProperty string

The property name to sort results by.

pageOptions.sortByAscending boolean

When true, sorts results in ascending order; descending otherwise.

pageOptions.searchValues object

Key-value pairs used to filter results.

pageOptions.findCodeToIncludeInPage string

A specific code to locate; the page containing it will be returned.

pageOptions.searchHistoricData boolean

When true, includes soft-deleted or historical records in the results.

Responses

200

OK

application/json

Schema

Schema

page int32required

The current page number in the paginated result set.

count int32required

The number of items returned on this page.

hasNextPage booleanrequired

Indicates whether additional pages of results are available after the current page.

hasPreviousPage booleanrequired

Indicates whether pages of results exist before the current page.

totalCount int32required

The total number of items across all pages.

totalPages int32required

The total number of pages available.

items object[]nullable
The collection of items returned for the current page.
Array [
id int32required
The unique identifier of this record.
isSuspicious booleanrequired
Indicates whether the customer is flagged as suspicious.
checksum stringnullablerequired
The checksum of the watchlist version used for screening.
macthedValue stringnullablerequired
The value that matched against the watchlist entry.
macthedField stringnullablerequired
The field name that produced the watchlist match.
score int32required
The match confidence score.
watchListName stringnullablerequired
The name of the watchlist where the match was found.
recordCode stringnullablerequired
The code of the matched watchlist record.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
]

Example (from schema)

{
  "page": 0,
  "count": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "totalCount": 0,
  "totalPages": 0,
  "items": [
    {
      "id": 0,
      "isSuspicious": true,
      "checksum": "string",
      "macthedValue": "string",
      "macthedField": "string",
      "score": 0,
      "watchListName": "string",
      "recordCode": "string",
      "createdBy": "string",
      "updatedBy": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

Not Found

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...