All requests must first be Authorized and must use the HTTP GET method over HTTPS. Results are encoded int UTF-8.
This call allows you to search for Companies or Registered Business Names.
https://api.vision-net.ie/cws/2.3/companies?company_bus_ind={{COMPANY_BUS_IND}}&company_num={{COMPANY_NUM}}&company_name={{COMPANY_NAME}}&searchType={{SEARCHTYPE}}&address={{ADDRESS}}&skip={{SKIP}}&max={{MAX}}&sortBy={{SORTBY}}&sortDir={{SORTDIR}}&format={{FORMAT}}&htmlEnc={{HTMLENC}}
| Parameter | Type | Description |
|---|---|---|
| company_bus_ind | C, B or E | C) Company (default) B) Registered Business Name E) Search both companies and Registered Business Names. |
| company_num | Positive Integer | The Company Number Or Registered Business Number as defined by the CRO. If the company_num is supplied then all other fields are ignored. |
| company_name | String |
A partial or full Company or Registered Business Name to search for (depending on
company_bus_ind). You must pass at least 3 alphanumeric characters to perform a search.
Some pre-processing is performed on the input String.
|
| address | String | A partial or full Registered Address to search for. |
| searchType | 1, 2 or 3 | 1) Exact match 2) Starts with this phrase (default). 3) Contains this phrase The characters & and + are replaced with the word and for searches. For option 2 and option 3 all other non-alphanumeric character (such as space, comma, dot) are replaced by a "like", so any number of characters can appear in there. If you are confident that three characters appear in the company name in order, you can send CBS instead of C.B.S. We strongly discourage passing LIMITED or LTD or PLC or DAC or similar suffixes. |
| coStatus, coStatusNot, coType, coTypeNot, busStatus, busStatusNot, busType, busTypeNot | Lookup Table ID | Optionally include or exclude companies/businesses with specified status or type. These parameters can be used multiple times to specify multiple values (coStatus=1&coStatus=2) |
| skip | Positive Integer | The number of results to skip. Useful if paging through results. |
| max | Positive Integer | The maximum number of results to return. We will only return a maximum of 250 results per search, so it cannot be higher than 250. |
| sortBy | String | Allowable values include:
company_num company_bus_ind company_name (default) company_addr_1 company_addr_2 company_addr_3 company_addr_4 company_reg_date company_status_desc company_status_date last_ar_date next_ar_date last_acc_date comp_type_desc |
| sortDir | ASC or DESC | Sort ascending (default) or descending. |
| format | XML or JSON | Return the results in XML (default) or JSON format. |
| htmlEnc | 0 or 1 | If set to one, then String fields will be encoded in HTML format. For XML this parameter is forced to 1. For example, ampersands will be encoded as & |
We reserve the right to require minimum field lengths, or to limit the maximum number of results which are returned to 250.