All requests must first be Authorized and must use the HTTP GET method over HTTPS.

Provides our full background check report for a name and address. JSON or XML request returns the summary counts, while PDF request returns a full report PDF data stream.

Registries searched:

• Consumer Judgments
• Disqualified/Restricted Persons
• Bankruptcy
• Insolvency Service Records
• Revenue Defaulters (since Q1 2012)
• Current and Previous Directorships
• Shareholding
• Business Ownerships
• Politically Exposed Person

https://services.vision-net.ie/cws/1.6/Check-Individual/{last_name}/{first_name}?dob={dob}&county={county}&county_prev={previous_county}&maiden_name={maiden_name}&includePEP={includePEP}&pep_country={pep_country}&userRef={user_ref}&format={FORMAT}&searchMode={searchMode}

Parameter	Type	Description
last_name	String	Last Name.
first_name	String	First Name.
dob	Date String	Optional. Date of Birth in a DD-MM-YYYY format.
county	Integer	Optional. Current County ID as in Lookup Tables.
county_prev	Integer	Optional. Previous County ID as in Lookup Tables.
pep_country	ISO2 String	Optional. Used to limit included PEP search only. ISO 2 country code as in Lookup Tables.
maiden_name	String	Optional. Maiden Name.
includePEP	Boolean	Optional. Include PEP registry search.
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.
searchMode	Integer	Optional 1 - Provided name and surname must match exactly 2 - name%surname wildcard 3 - Default. name%surname% wildcard.

Where a county specified is a Dublin post code (id 50-71), such area will be used in Judgments, Disq/Restricted, Bankruptcy, ISI and Revenue Defaulters searches.
Directorships, Shareholdings and Business Ownerships will search whole Dublin county based on remaining search criteria. PEP check, if requested, will cover either whole Ireland, if irish county is supplied, or country if supplied, worldwide otherwise.

Sample reply for /cws/1.0/Check-Individual/Smith/John?dob=01-04-1942&includePEP=true&county=11&format=json

Please enter your authorised email address to see the pdf report sample

Login:

{ "num_pep": 1, "num_disqualification": 1, "num_dsa": 1, "num_bankruptcy": 1, "input_name": "YASMIN", "num_business_name": 0, "num_sanction": 0, "num_shareholding": 0, "num_pia": 0, "input_surname": "TOWNSEND", "num_directorship_prev": 1, "num_drn": 0, "vn_api_version": 1, "num_defaulter": 1, "num_pc": 0, "num_directorship": 0, "num_judgment": 2 }

Field Name	Description	Inputs considered
input_name	Provided input name
input_surname	Provided input surname
input_dob	Provided input date of birth
input_county	Provided input Irish county
num_judgment	Irish judgments	Name & County
num_bankruptcy	Bankruptcies	Name & County
num_defaulter	Revenue Defaulters	Name & County
num_pep	Optional[includePEP]. Total PEP matches	Name, County and Year Of Birth
num_sanction	Optional[includePEP]. Sanctions matches	Name, County and Year Of Birth
num_disqualification	Director disqualification	Name, County and Date Of Birth
num_dsa	Debt Settlement Arrangement	Name, County and Year Of Birth
num_pc	Protective Certificate	Name, County and Year Of Birth
num_pia	Personal Insolvency Arrangement	Name, County and Year Of Birth
num_drn	Debt Settlement Arrangement	Name, County and Year Of Birth
num_directorship	Current directorships	Name, County and Date Of Birth
num_directorship_prev	Previous directorships	Name, County and Date Of Birth
num_shareholding	Company shareholdings	Name, County and Date Of Birth
num_business_name	Business ownerships	Name, County and Date Of Birth

NOTE: In case when DoB is provided, and record in the database does not have known DoB, such record will be returned if matches other inputs