Orders a new Pep Sanction Check Report

POST

/api/v1/pepsanction/order/{type}/{search}

v1-pepsanction

Order a new Pep Sanction Check by providing either a business or person name with some additional optional parameters.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.kompany.com//api/v1/pepsanction/order//'

Response Example

200 - Example 1

{}

Request

Path Params

type

string

required

Type (Business or Person) of the requested Pep Sanction Check

string

required

Search string for the Pep Sanction Check

Body Params application/x-www-form-urlencoded

Aliases

string

optional

Optional parameter for declaring alias names when doing a person search (seperated by commas)

Example:

null

Country

string

optional

Optional name of Country to assist in identifying matches based upon location/geography.

Example:

null

DOB

string

optional

Optional parameter for date of birth name when doing a person search

Example:

null

FamilyName

string

optional

Optional parameter for last name when doing a person search

Example:

null

Filters

string

optional

Optional parameter for restricting search when doing a person search (seperated by commas)

Example:

null

GivenName

string

optional

Optional parameter for first name when doing a person search

Example:

null

LEI

string

optional

Optional Legal Entity Identifier for additional business identifier verification.

Example:

null

Locale

string

optional

Optional name of City or Locale to assist in identifying matches based upon location/geography.

Example:

null

Medialists

string

optional

Optional parameter for selecting only specific media lists. By default all lists are queried

Example:

NMEDIA

MiddleName

string

optional

Optional parameter for middle name when doing a person search

Example:

null

Monitoring

string

optional

If this Pep Sanction Check should be continuesly monitored.

Peplists

string

optional

Optional parameter for selecting only specific pep lists. By default all lists are queried

Example:

GOV,PEPD,SOE

Region

string

optional

Optional name of Region or State to assist in identifying matches based upon location/geography.

Example:

null

SmartMatch

string

optional

Optional parameter for enabling SmartMatch to retrieve more results

Watchlists

string

optional

Optional parameter for selecting only specific watch lists. By default all lists are queried

Example:

SANCTIONS,FINANCE,TERRORISM,CRIME,SMAGOV,OFAC,MEDICAL

Webhook

string

optional

If Monitoring is enabled this parameter is required. This is where updates will be sent to

Example:

null

Responses

🟢200Success

application/json

Body

object {0}

🔴500500

Update details of active Pep Sanction monitor

Returns a json or pdf report