All requests must first be Authorized and must use the HTTP POST method over HTTPS. You must also have PEP account permission to use this report.
Provides Politically Exposed Person (PEP) and Sanctions check against an individual. JSON or XML request returns the summary counts. The PDF request returns a full report in a PDF data stream.
POST request format (recommended):
Endpoint:
https://api.vision-net.ie/cws/2.4/PEPCheck/
Parameters
| Parameter | Type | Description |
|---|---|---|
| last_name | String | Last Name (or surname). The first_name and last_name combined must be 6 characters or more (combined). |
| first_name | String | First Name. The first_name and last_name combined must be 6 characters or more (combined). |
| full_name | String | Optional. Full name string containing first and last name (in that order) that can be used INSTEAD of separate name fields above. |
| dob | String | Optional. The person's date of birth. Either dd-mm-yyyy or yyyy only. If dd-mm-yyyy is passed, the check will be carried out using whole of that year. |
| county | Integer[] | Optional. Up to 5 counties to search as per Lookup Tables.. If you do not provide the county, then your search results might contain people other than your intended subject. |
| pep_country | ISO2 String | Optional. The country to search in. Ignores county parameter for non-Irish countries. ISO2 country code as in Lookup Tables. |
| pep_nationality | ISO2 String | Optional. The nationality of the individual. ISO2 country code as in Lookup Tables. |
| bankruptcy | Boolean | Optional, default true. Will use valid county area search if provided. If you want a detailed background check, perhaps you should be calling our Credit Check Individual (CCI) service with included PEP results instead. It searches more datasets. |
| userRef | String | Optional. User reference to link this charge back to your own database. |
| format | XML, JSON or PDF | Return the result count in XML (default), the result count in JSON or the full report in PDF format. |
If pep_country is not supplied, then a worldwide search is performed.
PEP Match Algorithm
The provided name and surname is matched against data in database as %FIRST_NAME% (% is a wildcard) and LAST_NAME (exact). This includes various aliases each individual can have (including English translations of foreign names). We recognise that this configuration can return false positives, i.e. if you search for ANA SKYWALKER, will also return ANAKIN SKYWALKER, but also means less chance of missing a relevant record which has recorded multiple forenames or middle names.
Individuals can have multiple addresses, and a match is returned if any of the addresses match the provided one. They can also have multiple name aliases recorded (i.e. Joe and Joseph and Joey), so any match will be returned. In some cases when a date-of-birth cannot be found from an official source, multiple DoB’s might be recorded for that person. So if you enter either of those DoB’s in your search, you will get a match.
In addition to first and last name, these optional parameters are available:
- Address country or nationality of an individual can be supplied, which will filter profiles matching only such country, and also return profiles with unknown country origin.
- Irish counties (up to 5) can be provided which works the same as above.
- A Date of Birth (full or year only) can be provided. This will filter by profiles only matching provided YEAR of birth (not exact day of birth) due to possible source data discrepancies, and also return profiles with unknown DoB.