Sign in

v1

latestOpenAPI 3.1.02026-08-042010999.7 KB
One-Off Screening

Real-time Single Screening

This endpoint is used to perform a screen of a single entity. It is done synchronously and returns a summary of the results. You must specify a filter set, which will be used for this search. The fields, coverage, and match threshold are determined by the filterset.

post/screening/full-single

Request body

aliasesstring[] nullable

Secondary names to perform a search on

countriesstring[] nullable

ISO 3166-1 alpha-2

createAlertsboolean nullable

Optional. If true, alerts will be generated for this query if the results contain risk. Alerts are available in the UI or through webhook notifications.

customerKeystring

Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.

dobstring nullable

Birth or foundation date. YYYY, YYYY-MM, YYYY-MM-DD, YYYY/MM or YYYY/MM/DD format.

entityNamestring required

The primary name of the search

entityType'person' | 'company' | 'aircraft' | 'vessel' nullable
filterSetIDinteger required

The Filter Set to use for this search. You may create and view your filtersets in the UI, under Settings > Filter Sets..

Example request

{
  "aliases": [
    "InGen, InGen Corp"
  ],
  "countries": [
    "US"
  ],
  "customerKey": "ABC1234567890",
  "dob": "1993-06-11",
  "entityName": "InGen Corporation",
  "entityType": "company"
}

Response

OK

alertCreatedURNstring

Populated if the search resulted in an alert being created. Contains the URN of the alert. Only valid if using createAlerts=true in the request.

resultCountinteger required

Number of individual matches found

searchDatestring date-time required