Introduction

    API Endpoint

        https://my.search4less.com/api/v1/

Search4less exposes a RESTful JSON API providing access to data relating to Irish companies, business names and auditor firms.

To use this API, you need a username and API key. If you do not currently have credentials, please contact us at info@search4less.com to arrange access.

Note: Unless otherwise stated, a value of 0 (zero) for an epoch seconds date field indicates that no date is available for that field.

Note: Unless otherwise stated, String fields should be checked for "emptiness" to indicate data being unavailable. If null is a possible value for a field, it will be indicated below for the respective field.

Note: Unless otherwise stated, all JSON response keys will be present in response data e.g. see ROA.currAgent in Company Response

Get Details


# Here is a curl example
curl -G \
--data-urlencode 'username=your_api_username' \
--data-urlencode 'password=your_api_key' \
--data-urlencode 'id=511114' \
--data-urlencode 'type=C' \
--data-urlencode 'name=Vmody Limited' \
--data-urlencode 'gzip=no' \
--data-urlencode 'pretty=yes' \
https://my.search4less.com/api/v1/GetDetails

To get details for an entity you need to make a GET call to the following url :
https://my.search4less.com/api/v1/GetDetails


QUERY PARAMETERS

Field Type Description
username String Your API account username
password String Your API account password/key
type String The entity type for which details are being requested - must be one of the following characters:
'A' for auditor firm
'B' for Business Name
'C' for company
'P' for Person
id String Identifying number for the entity (as indicated by the type parameter) – this should be the CRO number for companies and business names. For auditor firms, use the auditor ID (e.g. CP5897)
name String Name of the entity being requested (if available) – this should be the name of the company, business or auditor firm being requested but the actual data returned is completely dependent on the id parameter. This is not required when requesting Person details
pretty Boolean (optional - default: false) Pretty print returned JSON with readable indentation
gzip Boolean (optional - default: true) Return data in gzip compressed format – recommended for performance

Get Document


# Here is a curl example
curl -G \
--data-urlencode 'username=your_api_username' \
--data-urlencode 'password=your_api_key' \
--data-urlencode 'type=C' \
--data-urlencode 'entityId=98789' \
--data-urlencode 'docId=58279494' \
--data-urlencode 'desc=B1 Annual Return for Eircom Ltd' \
https://my.search4less.com/api/v1/GetDocument

To retrieve a document in PDF format pertaining to a Business or Company you need to make a GET call to the following url:
https://my.search4less.com/api/v1/GetDocument


QUERY PARAMETERS

Field Type Description
username String Your API account username
password String Your API account password/key
type String The entity type for which details are being requested - must be one of the following characters:
'B' for Business Name
'C' for company
entityId String Identifying number for the entity (as indicated by the type parameter) – this should be the CRO number for companies and business names.
docid String Identifying number of the document submission for the entiity specified by the entityId parameter.
desc String A description of the document – this parameter is required but a successful response is not dependent on this value – use something descriptive if possible e.g. “B1 Annual Return for Some Company”

Company Response

The company response returns a JSON Object. Below is a description of the keys and corresponding values and data types. 


Example company result (TBC)  :

{
    "addr": "",
    "authorisedpeople": [],
    "bondexpirydate": 0,
    "businessnames": [
        {
            "addr": "",
            "bnum": 0,
            "datefrom": 0,
            "dateto": 0,
            "name": "",
            "natureofbusiness": "",
            "pnum": 0
        }
    ],
    "capitalamountissued": 0,
    "capitalauthorisedamount": 0,
    "capitalcurrencycode": 0,
    "capitalcurrencydesc": "",
    "centralBankSanctions": [],
    "charges": [],
    "chargespersonentitled": [],
    "chargesproperties": [],
    "chargespropertyreleased": [],
    "chargessatisfactions": [],
    "companiesActMatters": [],
    "compstatusdate": 0,
    "coname": "",
    "conum": 0,
    "county": "",
    "createdby": "",
    "createdon": 0,
    "creditorsmeetings": [],
    "directorships": [],
    "dissolveddate": 0,
    "docs": [
        {
            "accountstodate": 0,
            "auditorid": "",
            "auditorname": "",
            "auditortype": "N",
            "docid": 56154894,
            "doctypecode": 1,
            "doctypedesc": "",
            "effectivedate": 0,
            "receiveddate": 0,
            "subdocnum": 0,
            "submissionnum": 0,
            "submissionstatus": 0,
            "submissionstatusdesc": "",
            "subregdate": 0
        }
    ],
    "eircode": "",
    "employeeCount": "",
    "examinersappointed": [],
    "financials": [
        {
            "cash": 0,
            "currAssets": 0,
            "currLiability": 0,
            "isGroupAcc": false,
            "netAssets": 0,
            "turnover": 0,
            "yearEndMillis": 0
        }
    ],
    "judgments": [],
    "judgmentsawarded": [],
    "lastacdate": 0,
    "lastardate": 0,
    "liquidatorsappointed": [],
    "naceCode": "",
    "naceDescription": "",
    "nameEffDate": 0,
    "nard": 0,
    "otherAddr": [],
    "people": [
        {
            "addr": "",
            "dob": 0,
            "dors": "",
            "fromdate": 0,
            "name": "",
            "pnum": 0,
            "reltype": 0,
            "todate": 0
        }
    ],
    "peoplesnapshots": [
        {
            "addr": "",
            "county": "",
            "cronum": 0,
            "name": "",
            "ptype": "",
            "reltype": 0
        }
    ],
    "petitions": [],
    "prevShareholders": [
        {
            "id": 0,
            "name": "",
            "num": 0,
            "percent": 0,
            "type": ""
        }
    ],
    "prevShareholdings": [],
    "previousnames": [],
    "prinobjectcode": "",
    "prinobjectdesc": "",
    "receiversappointed": [],
    "regdate": 0,
    "roaID": "",
    "secretaryships": [
        {
            "coname": "",
            "conum": 0,
            "fromdate": 0,
            "status": "0",
            "todate": 0
        }
    ],
    "shareholders": [
        {
            "id": 0,
            "name": "",
            "num": 0,
            "percent": 0,
            "type": ""
        }
    ],
    "shareholdings": [],
    "statuscode": 0,
    "statusdesc": "",
    "ROA": {
        "allAgents": []
    },
    "taxdefaulters": [],
    "typeEffDate": 0,
    "typecode": 0,
    "typedesc": ""
}
Field Type Description
conum Integer CRO company number (same as supplied in query parameters)
coname String Name of the company
addr String Current known registered address
county String County where the company is currently registered
eircode String Eircode relating to the companies registered address
otherAddr Array String list containing zero or more previously registered addresses
employeeCount String Approximate guide to the number of employees in the company e.g. "1-3", "3-10", "30-100", "100+"
statuscode Integer Number indicating the current status of the company e.g. normal, dissolved
statusdesc String Description of the status code indicated by statuscode
typecode Integer Number indicating the type of the company e.g. LTD - Private Company Limited by Shares
typedesc String Description of the type code indicated by typecode
naceCode String NACE code indicating classification of economic activity
naceDescription String Description of the NACE code indicated by naceCode (if available)
prinobjectcode String Principal Object Code e.g. 72.30
prinobjectdesc String Description of the principal object code indicated by prinobjectcode e.g. Data Processing
regdate Integer Date of registration/incorporation of the company
lastardate Integer Date of Last Annual Return
dissolveddate Integer Date of dissolution of the company
bondexpirydate Integer Bond expiry date
nard Integer Date of Next Annual Return
lastacdate Integer Date of Last Accounts
compstatusdate Integer Date when company status was last changed
nameEffDate Integer Date representing last effective company name change
typeEffDate Integer Date representing last effective company type change
roaID String Identification number of the Registered Office Agent currently acting on behalf of this company (if applicable)
ROA Object Details of any Registered Office Agent(s) involved with this company
Object ROA.currAgent - Data relating to the office agent that is currently acting on behalf of this company (if applicable - this key will not be present if there is currently no agent acting on behalf of the company)
Integer ROA.currAgent.conum - Agent company number
String ROA.currAgent.coname - Agent company name
String ROA.currAgent.address - Agent company registered address
String ROA.currAgent.eircode - Agent company eircode
Integer ROA.currAgent.dateFrom - Date that agent began acting on behalf of the company
Integer ROA.currAgent.dateTo - Date that agent ceased acting on behalf of the company
Array ROA.allAgents - Object list containing data for zero or more office agents (in the format shown above) that have ever been involved with this company (NOTE: if the ROA.currAgent object is available, it will be repeated here)
taxdefaulters Array Object list containing data for zero or more Revenue compliance notices
Integer taxdefaulters.id - Unique identifier for this penalty
Integer taxdefaulters.tax - Amount of tax due (zero if no data available)
Integer taxdefaulters.interest - Amount of interest due (zero if no data available)
Integer taxdefaulters.fine - Fine amount for this penalty (zero if no data available)
Integer taxdefaulters.interestandfine - Combination of interest and fine (zero if no data available). In some instances, individual fine and interest values are unavailable, so only fine+interest is provided.
String taxdefaulters.additionalpenalty - Additional penalty description (if applicable) e.g. prison sentence
Integer taxdefaulters.numcharges - Number of charges related to this penalty
Integer taxdefaulters.offensecode - Identification code for the offense related to this penalty
String taxdefaulters.offensedesc - Description of the offense related to this penalty e.g. failure to lodge income tax return
Integer taxdefaulters.periodfrom - Commencement period for this penalty (penalties are registered sometime within a defined period of months) NOTE: this date value is in epoch milliseconds
Integer taxdefaulters.periodto - Conclusion period for this penalty (penalties are registered sometime within a defined period of months) NOTE: this date value is in epoch milliseconds
String taxdefaulters.settled - "Y" if this penalty has been settled, otherwise penalty is not settled or data is not available regarding penalty settlement
Integer taxdefaulters.penaltyAmount - Revenue penalty amount (zero if no data available)
Integer taxdefaulters.amountUnpaid - Amount of penalty/fine that is unpaid (zero if no data available)
peoplesnapshots Array Object list containing data for zero or more active officers for this company (this is for convenience, people will contain data for both past and present officers)
Integer peoplesnapshots.cronum - Internal indentification number assigned to this specific instance of this person by the CRO
String peoplesnapshots.ptype - Single letter code to indicate the general type of this officer: 'P' for person, 'C' for company, 'B' for business name.
Integer peoplesnapshots.reltype - Type code to indicate the role of this officer e.g. Director, Secretary
String peoplesnapshots.name - Full name of this officer
String peoplesnapshots.addr - Full address for this officer
String peoplesnapshots.county - County for this officers address
judgmentsawarded Array Object list containing data for zero or more judgments that have been awarded to this company
Integer judgmentsawarded.jid - Unique identifier for this judgment
Integer judgmentsawarded.regdate - Date this judgment was awarded
Float judgmentsawarded.amount - Amount of the judgment
Float judgmentsawarded.amountPartPaid - Amount of the judgment that is currently part paid (if any)
Float judgmentsawarded.amountSatisfied - Amount of the judgment that is currently satisfied
Float judgmentsawarded.costs - Amount of costs for the judgment
Integer judgmentsawarded.defconum - CRO company number, if the judgment defendant is a company (zero if the defendant is not a company)
Integer judgmentsawarded.defpnum - Internal Search4less identifier for the defendant, if the defendant is a person (zero if the defendant is not a person)
String judgmentsawarded.defname - Full name of the defendant
Integer judgmentsawarded.satisfieddate - Date that the judgment was satisfied (epoch seconds - zero if not satisifed)
String judgmentsawarded.defendantaddress - Full address of the defendant
String judgmentsawarded.defendantoccupation - Occupation of the defendant
Integer judgmentsawarded.defendanttradingas - Trading name of the defendant
people Array Object list containing data for zero or more officers for this company (both past and present)
Integer people.fromdate - Date that this officer appointment commenced
Integer people.todate - Date that this officer appointment ceased (zero if still active)
Integer people.dors - Code indicating the general type and role of this officer. Possible values are:
"D": Person Director
"S": Person Secretary
"CD": Company Director
"CS": Company Secretary
"BD": Business-Name Director
"BS": Business-Name Secretary
Integer people.pnum - If the officer is a person, this is a unique Search4less identifier. If the officer is a company or business name and isMatched is "Y", then this is the CRO identifier for this entity (if isMatched is "N", this is an internal CRO identifier for the entity).
String people.addr - Full name for this officer
Integer people.dob - Date of birth for this officer
String people.name - Full address for this officer
Integer people.reltype - Type code to indicate the role of this officer e.g. Director, Secretary
String people.isMatched - This key is only present if the officer is a company or business name. "Y" if the entity is an Irish registered entity with the CRO, otherwise "N".
secretaryships Array Object list containing secretaryships held by this company (past and present)
Integer secretaryships.fromdate - Date that this secretaryship appointment commenced
Integer secretaryships.todate - Date that this secretaryship appointment ceased
Integer secretaryships.conum - CRO number of the company acting as secretary
Integer secretaryships.coname - Name of the company acting as secretary
Integer secretaryships.status - Number indicating the current status of the company acting as secretary e.g. normal, dissolved
directorships Array Object list containing directorships held by this company (past and present)
Integer directorships.fromdate - Date that this directorship appointment commenced
Integer directorships.todate - Date that this directorship appointment ceased
Integer directorships.conum - CRO number of the company acting as director
Integer directorships.coname - Name of the company acting as director
Integer directorships.status - Number indicating the current status of the company acting as director e.g. normal, dissolved
charges Array Object list containing mortgage charges for this company
Integer charges.id - Unique identifying number for this charge
Integer charges.regdate - Date that this charge was registered
Integer charges.createddate - Date that this charge was created
Integer charges.procacqdate - Date that this charge property was acquired
Integer charges.currcode - Currency code relating to the monetary amounts for this charge
Decimal charges.amtsecured - Monetary amount secured
Integer charges.chargestatuscode - Numeric code indicating the current status of this charge
String charges.desc - Description for the type of this charge
String charges.amtsecureddesc - Description of the amount secured for this charge
String charges.docSubNum - Identifier of the document submission associated with this charge (if any)
String charges.furtherParticulars - Two possible values: 'Y' if further particulars are available, 'N' otherwise
String charges.plusInterest - Two possible values: 'Y' if monetary value is inclusive of interest, 'N' otherwise
String charges.c1aLink - Link to a C1A form (if any)
Integer charges.chargeRecDate - Date that this charge was received
chargespersonentitled Array Object list containing entitled parties related to any mortgage charges for this company
Integer chargespersonentitled.cnum - ID of the charge that this person entitled is associated with (see charges.id)
Integer chargespersonentitled.creltypecode - Relationship type code
String chargespersonentitled.name - Name of the person entitled
String chargespersonentitled.addr - Address of the person entitled
String chargespersonentitled.county - County of the person entitled
chargesproperties Array Object list containing properties related to any mortgage charges for this company
Integer chargesproperties.cnum - ID of the charge that this property is associated with (see charges.id)
Integer chargesproperties.pnum - Unique identifier for this charge property
String chargesproperties.desc - Description of the property
chargespropertyreleased Array Object list containing released properties related to any mortgage charges for this company
Integer chargespropertyreleased.cnum - ID of the charge that this released property is associated with (see charges.id)
Integer chargespropertyreleased.snum - Identifier for the satisfaction associated with this released property
Integer chargespropertyreleased.prnum - Unique identifier for this released property
String chargespropertyreleased.desc - Description of the released property
chargessatisfactions Array Object list containing charge satisfactions related to any mortgage charges for this company
Integer chargessatisfactions.cnum - ID of the charge that this satisfaction is associated with (see charges.id)
Integer chargessatisfactions.snum - Unique identifier for this satisfaction
Integer chargessatisfactions.stypecode - Code indicating the type of this satisfaction: 0 = Unknown, 10 = Partial Satisfaction, 20 = Full Satisfaction
Integer chargessatisfactions.sdate - Date that this satisfaction was registered
String chargessatisfactions.satstatus - Current status code for this satisfaction: UNK=Unknown, INT=Interim, REG=Registered, OBJ=Objection Received
String chargessatisfactions.notes - Notes for this satisfaction
docs Array Object list containing document submissions for this company (unique identifier is a combination of submissionnum and subdocnum) OR docid
String docs.submissionnum - Identifier for this submission
Integer docs.subdocnum - Identifier for this document relative to this submission
Integer docs.doctypecode - Code indicating the type of this document
String docs.doctypedesc - Description indicating the type of this document
Integer docs.receiveddate - Date indicating when this document was received by the CRO
Integer docs.effectivedate - Date indicating from when this document is effective
Integer docs.submissionstatus - Code indicating the current status of this document
String docs.submissionstatusdesc - Description indicating the current status of this document
Integer docs.docid - Identifier for the FileNetID of this document
Integer docs.accountstodate - Date indicating the accounts-to-date relevant to this document (if applicable)
Integer docs.subregdate - Date indicating when this document was registered by the CRO
String docs.auditorid - Identifier for the auditor associated with this document (if any)
String docs.auditortype - Code indicating the type of auditor associated with this document (if any): U=Unknown, I=Individual, F=Firm
String docs.auditorname - Name of the auditor associated with this document (if any)
examinersappointed Array Object list containing examiners appointed to this company (past and present)
Integer examinersappointed.appointmentdate - Date that this examiner appointment was made
Integer examinersappointed.dateCeased - Date that this examiner appointment ceased
String examinersappointed.county - Examiners county
String examinersappointed.eircode - Examiners eircode
Integer examinersappointed.relType - Code indicating the relationship type of this examiner
String examinersappointed.eType - Code indicating the type of the examiner: P=Person, C=Company, B=Business
String examinersappointed.examiner - Name and full address of the examiner involved in this appointment
receiversappointed Array Object list containing receivers appointed to this company (past and present)
Integer receiversappointed.appointmentdate - Date that this receiver appointment was made
Integer receiversappointed.dateCeased - Date that this receiver appointment ceased
String receiversappointed.county - Receivers county
String receiversappointed.eircode - Receivers eircode
Integer receiversappointed.relType - Code indicating the relationship type of this receiver
String receiversappointed.eType - Code indicating the type of the receiver: P=Person, C=Company, B=Business
String receiversappointed.receiver - Name and full address of the receiver involved in this appointment
liquidatorsappointed Array Object list containing liquidators appointed to this company (past and present)
Integer liquidatorsappointed.appointmentdate - Date that this liquidator appointment was made
Integer liquidatorsappointed.dateCeased - Date that this liquidator appointment ceased
String liquidatorsappointed.county - Liquidators county
String liquidatorsappointed.eircode - Liquidators eircode
Integer liquidatorsappointed.relType - Code indicating the relationship type of this liquidator
String liquidatorsappointed.eType - Code indicating the type of the liquidator: P=Person, C=Company, B=Business
String liquidatorsappointed.liquidator - Name and full address of the liquidator involved in this appointment
petitions Array Object list containing High-Court petitions submitted for this company
Integer petitions.petitiondate - Date that this petition was issued
String petitions.description - Description of this petition
creditorsmeetings Array Object list containing creditors meetings for this company
Integer creditorsmeetings.meetingdate - Date that this creditors meeting is due to be held
String creditorsmeetings.meetingaddress - Description for this creditors meeting
shareholders Array Object list containing current shareholders for this company
Integer shareholders.id - Unique identifier for this shareholder
String shareholders.type - Code indicating the type of this shareholder: U=Unknown, P=Person, C=Company
Integer shareholders.num - CRO number if this shareholder is a company, otherwise Search4less identifier number
String shareholders.name - Name of the shareholder
Decimal shareholders.percent - Percentage that this shareholder holds
prevShareholders Array Object list containing previous shareholders for this company (Note: where available, this list is not exhaustive)
Integer prevShareholders.id - Unique identifier for this shareholder
String prevShareholders.type - Code indicating the type of this shareholder: U=Unknown, P=Person, C=Company
Integer prevShareholders.num - CRO number if this shareholder was a company, otherwise Search4less identifier number
String prevShareholders.name - Name of the shareholder
Decimal prevShareholders.percent - Percentage that this shareholder held
shareholdings Array Object list containing shareholdings currently held by this company
Integer shareholdings.id - Unique identifier for this shareholding
Integer shareholdings.conum - CRO number of the company for which this company holds a share
String shareholdings.name - Name of the company for which this company holds a share
Decimal shareholdings.percent - Percentage share that this company holds
prevShareholdings Array Object list containing shareholdings previously held by this company
Integer prevShareholdings.id - Unique identifier for this shareholding
Integer prevShareholdings.conum - CRO number of the company for which this company held a share
String prevShareholdings.name - Name of the company for which this company held a share
Decimal prevShareholdings.percent - Percentage share that this company held
previousnames Array Object list containing previous names for this company
Integer previousnames.effectivedate - Date that this previous name came into effect
String previousnames.name - The previous company name
businessnames Array Object list containing business names / trading names associated with this company
Integer businessnames.datefrom - Date that this associated commenced
Integer businessnames.dateto - Date that this associated ceased
Integer businessnames.bnum - CRO number of the associated business name
String businessnames.name - Name of the associated business name
String businessnames.addr - Registered address of the associated business name
String businessnames.natureofbusiness - Nature of the associated business name
judgments Array Object list containing judgments that have been awarded against this company
Integer judgments.regdate - Date that this judgment was registered
Integer judgments.id - Unique identifer for this judgment
Decimal judgments.amount - Monetary total for this judgment
Decimal judgments.amountPartPaid - Monetary amount that has been partially paid
Decimal judgments.amountSatisfied - Monetary amount that has been satisfied
Decimal judgments.costs - Monetary amount of costs associated with this judgment
String judgments.plaintiff - Name of the plaintiff associated with this judgment
Integer judgments.datesatisfied - Date on which this judgment was fully satisfied
centralBankSanctions Array Object list containing sanctions against this company by the Central Bank
Integer centralBankSanctions.dateFrom - Date on which this sanction came into effect
String centralBankSanctions.description - Description of this sanction
String centralBankSanctions.fileId - File ID for this sanction document PDF
String centralBankSanctions.prevName - Name of this company when the sanction was applied (Note: this key/value will only be present if this company held a different name at the time of the sanction)
financials Array Object list containing annual financial information for this company e.g. Cash, Current Assets, Current Liabilities, Turnover
Integer financials.yearEndMillis - Date indicating the year-end to which this data relates
Boolean financials.isGroupAcc - True if this data relates to overall group accounts, false otherwise
Integer financials.turnover - Monetary turnover amount
Integer financials.cash - Monetary cash amount
Integer financials.currAssets - Monetary current assets amount
Integer financials.currLiability - Monetary current liability amount
Integer financials.netAssets - Monetary net assets amount




Business Response

The business-name response returns a JSON Object. Below is a description of the keys and corresponding values and data types.

Field Type Description
busnum Integer CRO business number (same as supplied in query parameters)
name String Name of the business
addr String Current known registered address
county String County where the business is currently registered
eircode String Eircode relating to the registered address
otherAddr Array String list containing zero or more previously registered addresses
natureofbusiness String The nature of the business, indicating the type of service provided
statuscode Integer Number indicating the current status of the business e.g. normal, dissolved
statusdesc String Description of the status code indicated by statuscode
typecode Integer Number indicating the type of the business e.g. Business Name - Individual
regdate Integer Date of registration of the business
ceaseddate Integer Date the business ceased trading
towncodenumber Integer Number identifying the Irish town where this business is registered
people Array Object list containing owners of this business that are people
Integer people.fromdate - Date that this person first became associated with the business
Integer people.todate - Date that this person ceased association with the business
Integer people.pid - Unique identifier for this person
String people.name - Name of this person
Integer people.dob - Birth date for this person
String people.addr - Known address for this person
prevbusnames Array Object list containing previous names for this business
Integer prevbusnames.effdate - Date that this previous name came into effect
Integer prevbusnames.prevbusnum - Number indicating the ordering of the previous name
String prevbusnames.prevbusname - The previous name
documents Array Object list containing document submissions for this business (unique identifier is a combination of subnum and docnum) OR docid
String documents.subnum - Identifier for this submission
Integer documents.docnum - Identifier for this document relative to this submission
Integer documents.typecode - Code indicating the type of this document
String documents.typedesc - Description indicating the type of this document
Integer documents.recdate - Date indicating when this document was received by the CRO
Integer documents.effdate - Date indicating from when this document is effective
Integer documents.status - Code indicating the current status of this document
String documents.statusdesc - Description indicating the current status of this document
Integer documents.docid - Identifier for the FileNetID of this document
taxdefaulters Array Object list containing data for zero or more Revenue compliance notices (see Company.taxdefaulters for more details)
ltdcos Array Object list containing owners of this business that are companies
Integer ltdcos.fromdate - Date that this company first became associated with the business
Integer ltdcos.todate - Date that this company ceased association with the business
Integer ltdcos.conum - CRO number for the company
String ltdcos.name - Name of the company
String ltdcos.addr - Registered address for the company
Integer ltdcos.statuscode - Numeric code indicating the current status of this company
String ltdcos.statusdesc - Description indicating the current status of this company
businessNameOwners Array Object list containing owners of this business that are businesses
Integer businessNameOwnerships.fromdate - Date that this business owner first became associated with the business
Integer businessNameOwners.todate - Date that this business owner ceased association with the business
Integer businessNameOwners.busnum - CRO number for the business owner
String businessNameOwners.name - Name of the business owner
String businessNameOwners.addr - Registered address for the business owner
Integer businessNameOwners.statuscode - Numeric code indicating the current status of this business owner
String businessNameOwners.statusdesc - Description indicating the current status of this business owner
secretaryships Array Object list containing secretaryships held by this business (past and present) (see Company.secretaryships for more details)
directorships Array Object list containing directorships held by this business (past and present) (see Company.directorships for more details)
businessNameOwnerships Array Object list containing other businesses for which this business is an owner
Integer businessNameOwnerships.fromdate - Date that this associated commenced
Integer businessNameOwnerships.todate - Date that this associated ceased
Integer businessNameOwnerships.busnum - CRO number of the associated business name
String businessNameOwnerships.name - Name of the associated business name
String businessNameOwnerships.addr - Registered address of the associated business name
String businessNameOwnerships.natureofbusiness - Nature of the associated business name
Integer businessNameOwnerships.statuscode - Numeric code indicating the current status of the associated business
String businessNameOwnerships.statusdesc - Description indicating the current status of the associated business
Integer businessNameOwnerships.dateceased - Date that the associated business ceased trading
centralBankSanctions Array Object list containing sanctions against this business by the Central Bank (see Company.centralBankSanctions for more details)




Person Response

The person response returns a JSON Object. Below is a description of the keys and corresponding values and data types.

Field Type Description
pnum Integer Unique identifier for the person (same as supplied in query parameters)
name String Name of the person
dob Integer Birth date of the person
addr String Current primary address
county String County of the current primary address
eircode String Eircode of the current primary address
otherAddr String Other known previous or alternate addresses
ltdcompanies Array Object list containing associations with companies for this person (secretaryships and/or directorships, past and present)
Integer ltdcompanies.fromdate - Date that the appointment to this company commenced
Integer ltdcompanies.todate - Date that the appointment to this company ceased
Integer ltdcompanies.number - CRO number for the company
String ltdcompanies.dors - Either the value 'D' or 'S', indicating whether the company appointment is as a director or secretary (reltype for more detailed appointment type)
String ltdcompanies.name - The name of the company
Integer ltdcompanies.status - Numeric code indicating the current status of the company
String ltdcompanies.statusdesc - Description indicating the current status of the company
Integer ltdcompanies.regdate - Date that the company was registered
String ltdcompanies.addr - Registered address for the company
Integer ltdcompanies.reltype - Numeric code indicating the type of appointment to the company (see officer relationship type lookup)
businessnames Array Object list containing associations with businesses for this person (past and present)
Integer businessnames.fromdate - Date that the association with this business commenced
Integer businessnames.todate - Date that the association with this business ceased
Integer businessnames.number - CRO number for the business
String businessnames.name - Name of the business
shareholding Array Object list containing company shareholdings currently held by this person
Integer shareholding.sid - Unique identifier for this shareholding
Integer shareholding.number - CRO number of the company for which this person holds a share
String shareholding.name - Name of the company for which this person holds a share
Decimal shareholding.percent - Percentage share that this person holds
prevShareholding Array Object list containing company shareholdings previously held by this person
Integer prevShareholding.sid - Unique identifier for this shareholding
Integer prevShareholding.number - CRO number of the company for which this person held a share
String prevShareholding.name - Name of the company for which this person held a share
Decimal prevShareholding.percent - Percentage share that this person held
judgments Array Object list containing judgments that have been awarded against this person (see Company.judgments for more details)
bankruptcies Array Object list containing bankruptcies adjudicated by the courts against this person
Integer bankruptcies.dateAdjudicatedSecs - Date that this bankruptcy was adjudicated
Integer bankruptcies.dateDischargedSecs - Date that this bankruptcy was discharged
Integer bankruptcies.status - Current status description of this bankruptcy
disqualifiedorrestricteddirectors Array Object list containing corporate disqualifications or restrictions against this person
String disqualifiedorrestricteddirectors.type - Single letter code indicating whether this relates to a disqualification or restriction: "D" = Disqualification, "R" = Restriction
Integer disqualifiedorrestricteddirectors.appliesfrom - Date that this disqualification/restriction applies from (became active)
Integer disqualifiedorrestricteddirectors.appliesto - Date that this disqualification/restriction applies to (ceased being active)
String disqualifiedorrestricteddirectors.act - Description of the act associated with this disqualification/restriction
taxdefaulters Array Object list containing data for zero or more Revenue compliance notices against this person (see Company.taxdefaulters for more details)
centralBankSanctions Array Object list containing sanctions against this person by the Central Bank (see Company.centralBankSanctions for more details)




Auditor Response

The auditor response returns a JSON Object. Below is a description of the keys and corresponding values and data types.

TBC





Reference Code Lookup

See here for a complete listing of all possible required reference code lookups.





Errors

The Search4less API uses the following HTTP error codes:

Code Meaning
400 Bad Request - If the id, name or type parameters are missing from the request or if the type parameter is any value other than indicated above.
401 Unauthorized: If the username or password parameters are missing from the request, or if the password does not match the specified username.
429 Too Many Requests: If the number of requests from the customer account has exceeded the allowed quota for the current period.
501 Not Implemented: ( Only applicable for GetDocument Request ) If the requested document is not currently available.