Global Data
Browse endpoints
View as Markdown OpenAPI spec

PEP / Sanction Search

POST /api/v2/pep_sanction_check operationId: pep_sanction_check

Live: https://gdapi.globaldata.net.au/api/v2/pep_sanction_check · Sandbox: https://sandbox-gdapi.globaldata.net.au/api/v2/pep_sanction_check

PEP / Sanction Search is a powerful API query that can be used to find individuals or companies who are politically exposed persons or have an international sanction applied to them. The results provide a list of pep or sanction sources that the individuals or companies are listed on and there is the option to tailor the search to narrow, medium or broad.

Search Types

Narrow Search

A narrow search will match exact first name, exact last name and exact birth date. This is the most restrictive search and should be used for low risk searches. For companies, the search will match companies with names which contain the exact names provided.

Medium Search

A medium search will match exact last name and birth date year, and will allow for a partial match on other names. This is a good balance between accuracy and flexibility. For companies, this search will match companies names which contain the partial names provided. However the results will filter out any results where the matched name only consists of words from a stop word list. The stop word list is a list of common words that are not useful for matching, such as "group", "company", "LTD", etc.

Broad Search

A broad search will match partial first name, partial last name and partial birth date. This is the most flexible search and should be used for high risk searches. For companies, this search type will match companies with names which contain the partial names provided.

Note on Matching

When matching names, the API ignores the order of the names as some names may be reported in different orders. Consequently, it is possible to search for John Michael and find a match for an individual with a reported name of Michael John.

When matching company names, the API will ignore birth dates and pep countries.

Sandbox environment data

When simulating queries in the sandbox environment, the following records will return a match:

Individuals

First name Middle name Last name Birth date PEP? Sanctioned? Country
Ed Virgil Leuschke 1993-03-23 No Yes AU
Justus Tanner Beatty 1950-06-04 Yes No AU
Julien - Kovacek 2002-08-14 Yes No AU
Alford - McGlynn 1994-03-13 No Yes AU

Companies

Company name Sanction country
Southern Cross Commodities Pty Ltd AU, US
Baltic Petrochem Logistics OU EU, GB
Jade Meridian Holdings Pte Ltd US
Andes Orbital Freight SAC GB
Sahel Mineral Ventures SARL UN, AU

Request body

Content type application/json. The details of the individual to search for.

FieldDescription
company_name string [1..255 characters] or null

The name of the company to search for
vessel_name string [1..255 characters] or null

The name of the vessel to search for
first_name string [1..255 characters]

The first name of the individual

Example: Phil
middle_name string [1..255 characters] or null

The middle name of the individual
last_name string [2..255 characters]

The last name of the individual

Example: Smith
full_name string [2..255 characters] or null

The full name of the individual. This can be provided instead of first, middle and last names.
birth_date string (date)

The birth date of the individual

Example: 1938-10-24
search_type string

The type of search to perform. Narrow searches for exact matches, medium searches for similar matches and broad searches for partial matches.

Enum: narrow_search, medium_search, broad_search

Example: broad_search
pep_countries array of strings [items 2..7 characters]

A list of countries of the politically exposed person as a country code to include in the search
sanction_countries array of strings [items 2..7 characters]

A list of countries of the sanction as a country code to include in the search
max_results integer [1..100]

The maximum number of results to return

Default: 20

Example: 20
similarity_threshold number [0..100]

The minimum similarity percentage to return results for.

Default: 80

Example: 80
pep_sanction_extended_result boolean

Whether to return include the extended results for the individual matches

Default: false

Example: true

Responses

200

Successful response

application/json
FieldDescription
message string

A message indicating the result of the request. This will be Ok if the request was successful.

Example: Ok
api_reference string (uuid)

A unique identifier for this request. This can be used to track the request in the logs.

Example: fe4291ca-d831-4760-96df-c9cb03b3cd95
function string

The function that was called.

Example: pep_sanction_check
matches array of objects

Array of matched individuals.
matches[].uuid string (uuid)

The unique identifier of the individual.

Example: 389d8f0f-b2c4-465a-b2e9-8a14722031f7
matches[].caption string

Example: Phil Smith
matches[].is_pep boolean

Whether the individual is a politically exposed person.

Example: true
matches[].is_sanctioned boolean

Whether the individual is sanctioned.

Example: false
matches[].distance number

The levenshtein distance of the names of the individual to the search name.

Example: 0
matches[].similarity number

The percentage similarity of the matched name to the search name.

Example: 100
matches[].matched_name string

The name of the individual that was matched to the search name and used for the similarity score.

Example: PHIL SMITH
matches[].sanctions array of strings

Array of countries where the individual is sanctioned.
matches[].pep_matches array of strings

Array of sources where the individual has been identified as a pep.
matches[].sanction_matches array of strings

Array of sources where the individual has been identified as being sanctioned.
matches[].data object

Additional data about the individual which is included if pep_sanction_extended_result is true.
more_results boolean

Whether there are more results available.

Example: false
Standard error responses: 400 401 402 403 429 5XX See common error responses
Previous Phone Contact Validate Next PEP / Sanction Bulk Search