All requests must first be Authorized and must use the HTTP GET method over HTTPS.
Provides PEP and Sanctions check against an individual. JSON or XML request returns the summary counts, while PDF request returns a full report PDF data stream.
https://services.vision-net.ie/cws/1.6/PEPCheck/{last_name}/{first_name}?dob={dob}&county={county}&pep_country={pep_country}&bankruptcy={bankruptcy}&userRef={user_ref}
Parameter | Type | Description |
---|---|---|
last_name | String | Last Name. |
first_name | String | First Name. |
dob | String | Optional. 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 | int | Optional. Irish county ID as in Lookup Tables. |
pep_country | ISO2 String | Optional. Ignores county parameter for non-Irish countries. ISO2 country code as in Lookup Tables. |
bankruptcy | Boolean | Optional, default true. Will use valid county area search if provided. |
userRef | String | Optional. User reference. |
format | XML, JSON or PDF | Return the result count in XML (default), the result count in JSON or the full report in PDF format. |
PEP check, will cover either whole Ireland, if irish county is supplied, or worldwide otherwise.