Create Protect Investigation

Creates an Investigation according to the provided Investigation criteria. Each result is potential match which is attributed a relevancy/match score between 1-100 and a high level reason for it's inclusion in the World Compliance Database by looking at the Reason Listed and Comments to firstly ascertain whether the entry is a match for you search criteria and then utilize the data available for your own onboarding needs.

SecuritybearerToken
Request
Request Body schema: application/json
required
type
required
string

Individual relates to individuals
Business relates to businesses and organisations e.g political parties and terrorist groups.

Enum: "business" "individual"
name
string or null

The full or partial business or individual name

screeningThreshold
integer or null <int32>

Default Threshold is 85. Can only enter the following options: 85, 90, 95, 100

countryCode
string or null
firstName
string or null

Individual Only - To be used instead of ''name'' field should the user want to split out the name into first, middle, last.

middleName
string or null

Individual Only - To be used instead of ''name'' field should the user want to split out the name into first, middle, last.

lastName
string or null

Individual Only - To be used instead of ''name'' field should the user want to split out the name into first, middle, last.

dateOfBirth
string or null
gender
string or null
Enum: "male" "female"
Responses
201
400
default
post/protect/investigations
Request samples
application/json
{
  • "type": "business",
  • "name": "string",
  • "screeningThreshold": 0,
  • "countryCode": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dateOfBirth": "string",
  • "gender": "male"
}
Response samples
application/json
{
  • "correlationId": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "searchCriteria": {
    },
  • "scheduleId": "string",
  • "profileId": "string",
  • "profileName": "string",
  • "alertsCount": 0,
  • "currentAlert": {
    },
  • "results": [
    ]
}
➔ Next to List All Protect Investigations