All requests must first be Authorized and must use the HTTP POST method over HTTPS. You must also have CCI or PEP account permission to use this report.
Provides our full background check report for a name and address. JSON or XML request returns the summary counts only, while PDF request returns a full report PDF data stream. If you require further data in JSON/XML, please contact our sales team to register your interest in future enhancements.
Latest XSD schema is available here (right click and save as).
|Consumer Court Judgments||Negative||Always|
|Insolvency Service of Ireland Records (ISI)||Negative||Always|
|Current and Previous Directorships||Neutral||Excluded with negativeOnly|
|Shareholding||Neutral||Excluded with negativeOnly|
|Business Ownerships||Neutral||Excluded with negativeOnly|
|Politically Exposed Person(PEP) and Sanctions||Neutral||Included with includePEP|
Inclusion of negativeOnly=true parameter will improve response time greatly.
NOTE: Due to third party API integration, in case of an error fetching PEP details, a response of negative counts in num_pep/num_sanction fields will be returned with following meaning:
-1 INTERNAL ERROR while fetching the PEP data. Please repeat the request
-2 NAME ERROR. Provided name is too short and was not processed
POST request format:
|last_name||String||Mandatory||The person's surname. The first_name and last_name combined must be 6 characters or more.|
|first_name||String||Mandatory||First Name. The first_name and last_name combined must be 6 characters or more. We recommend you only supply one first name.|
|dob||String||Optional||Date of Birth in a DD-MM-YYYY format. Supplying the date of birth will give you more accurate results, particularly when it comes to company directorships and Business Ownerships.|
|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. If you want an accurate report, you should consider this as mandatory.|
|includePEP||Boolean||Optional||Default is false. Set to true to include a Politically Exposed Person search in your results (additional cost).|
|pep_country||String||Optional||Used to limit included PEP search only. ISO 2 country code as in Lookup Tables. This only applies if includePEP=true.|
|negativeOnly||Boolean||Optional||Default is false. Set to true to exclude Directors, Business Owners and Shareholding datasets. Greatly improves response time|
|maiden_name||String||Optional||Maiden Name. Effectively performs two searches, for the married name and maiden name. Therefore, more results will be returned.|
|userRef||String||Optional||User reference. Your "Usage Statement" will include this user reference, making it easy to link this record back to your own systems. Some customers like to pass an internal account ID or similar. This parameter does not affect the search performed.|
|format||XML, JSON or PDF||Optional||Defaults to XML. Return the result count in XML, the result count in JSON or the full report in PDF format. A future enhancement is planned to offer the full report contents in either XML or JSON. Contact our sales team to register your interest.|
|searchMode||Integer||Optional||Defaults to option 3.
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, Disqualified/Restricted Directors, 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.6/Check-Individual
"last_name" : "Townsend",
"first_name" : "Yasmin",
"dob" : "25-02-1957",
"includePEP" : true,
"county" : 
Please enter your authorised email address to see the pdf report sample
Data Output Descriptions
|Field Name||Description||Inputs considered||Data Type|
|input_name||Provided input name||String|
|input_surname||Provided input surname||String|
|input_dob||Provided input date of birth||Date as DD-MM-YYYY|
|input_county||Provided input Irish county||County Lookup Table|
|input_user_ref||Provided user reference||String|
|num_judgment||Irish judgments||Name & County||Integer|
|num_bankruptcy||Bankruptcies||Name & County||Integer|
|num_defaulter||Revenue Defaulters||Name & County||Integer|
|num_pep||Optional[includePEP]. Total PEP matches||Name, County and Year Of Birth||Integer|
|num_sanction||Optional[includePEP]. Sanctions matches||Name, County and Year Of Birth||Integer|
|num_disqualification||Director disqualification||Name, County and Date Of Birth||Integer|
|num_dsa||ISI Debt Settlement Arrangement||Name, County and Year Of Birth||Integer|
|num_pc||ISI Protective Certificate||Name, County and Year Of Birth||Integer|
|num_pia||ISI Personal Insolvency Arrangement||Name, County and Year Of Birth||Integer|
|num_drn||ISI Debt Relief Notice||Name, County and Year Of Birth||Integer|
|num_directorship||Current directorships||Name, County and Date Of Birth||Integer|
|num_directorship_prev||Previous directorships||Name, County and Date Of Birth||Integer|
|num_shareholding||Company shareholdings||Name, County and Date Of Birth||Integer|
|num_business_name||Business ownerships||Name, County and Date Of Birth||Integer|
|risk_factor||Risk indicator flag. If the only negative events are satisfied judgments, then medium. If there are any other negative events, then high. Otherwise low.||low|medium|high|