This method is used to obtain a list of companies based on a name of a company as supplied by the user. This list will contain the company registration number which can then be used in conjunction with the AddCompanyLookup method.
Request Parameters
| Parameter | Type | Format | Description |
|---|---|---|---|
| CompanyName Required | String | Max length 250 characters | Name of the company being searched |
| CompanyCountry Required | String | ISO 3166 Alpha-3 | The alpha-3 country code which the company is registered in. Only 'GBR' and 'IRL' are supported at this time |
| AutocompleteMode | Bool | Default is false |
By default all words provided need to be included in the company in order for it to be included as a result. e.g. "Company na" will not find "Company Name Ltd", but would find "Company NA Ltd" If this is set to true, the query will instead use a SQL LIKE clause and the results will only include companies that start with the string provided, e.g. "Company na" will find "Company Name Ltd" and "Company NA Ltd", but not "Company Inc NA" |
Response Parameters
| Parameter | Type | Format | Description |
|---|---|---|---|
| ResponseStatus | ResponseStatus | Instance of ResponseStatus object (see here) | |
| SearchResults | Array | Instance of CompanyLookup Company see below |
SearchResults Company
| Parameter | Type | Format | Description |
|---|---|---|---|
| Id | String | Company id | |
| Name | String | Company name | |
| Number | String | Company registration number | |
| Status | String | Company status | |
| Address | String | Company address | |
| Country | String | Company country |