Search for a company director
Find out what you can do with our API...
API method to use: director_details
Documentation on the T2A API director_details method which returns the details of a company director or other company officer.Description
Search for and find details about a company director or other company officer, using companies house data.
Return the details of a company director or other company officer, using a director ID returned by the person_search or company_details methods.
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. |
| director_id | The ID for the director, as returned by the person_search and company_details methods. |
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 <director_details_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. |
| director | A single director record, populated with the full information about the individual. |
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.
If the director_id is set to CUR, a current director example is returned; is the director_id is set to DIS, a disqualified director example is returned.
Note that the mode is returned as test when the method is operating in the free test mode.