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.3/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). |
| 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.