Company Name Search

Mandatory Parameters

---

Name	Description
api_key or javascript_key	Use your API key if invoking server-side. If invoking from the browser via JavaScript, generate a JavaScript key using the javascript_key method.
name	A UK company name.

Optional Parameters

---

Name	Description
client	You can optionally include an identifier for your final client or user. This is logged in your usage log and you will be able to view your usage statistics by client.
output	Set to json for a JSON response; the default response is XML. Not applicable to the SOAP API.
callback	When using JSON, specify a JSONP wrapper in which the JSON response is to be wrapped.

Returned Values

---

The XML response is contained within a <company_name_search_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
t2a_version_number	The current API version number.
credit_used	The number of credits used in order to execute the request.
mode	Returns normal or test when executed in the free test mode.
company_short_list	An array of company_short records. If present, this list shows the company or companies whose name(s) is or are too similar to the proposed name.

Error Codes

---

See the common error codes. There are no errors which are specific to this method.

Free Test Mode

---

When operating in the free test mode errors are returned if mandatory parameters are missing, or it returns a dummy data response, in an identical format to a real response.

Note that the mode is returned as test when the method is operating in the free test mode.

Example XML Response

---

<?xml version="1.0"?>
<company_name_search_res>
	<status>ok</status>
	<error_code/>
	<credit_used>0.01</credit_used>
	<mode>normal</mode>
	<chargeable>true</chargeable>
	<t2a_version_number>1.0.0</t2a_version_number>
	<previous_page_id/>
	<next_page_id/>
	<company_short_list>
		<company_short>
			<name>SIMUNIX LIMITED</name>
			<company_number>03684982</company_number>
			<data_set/>
			<place>HESLINGTON, YORK</place>
			<company_status>Active</company_status>
		</company_short>
	</company_short_list>
</company_name_search_res>

Example JSON Response

---

	{
		"previous_page_id":"",
		"next_page_id":"",
		"company_short_list":[
		{"name":"SIMUNIX LIMITED",
		"company_number":"03684982",
		"data_set":"",
		"place":"HESLINGTON, YORK","company_status":"Active"
		}
		],
		"mode":"normal",
		"status":"ok",
		"error_code":"",
		"chargeable":"true",
		"total_records":"1",
		"page_number":"0",
		"t2a_version_number":"3.6.3.4",
		"credit_used":"0.01"
	}