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 director_search, person_search or company_details methods.
Mandatory Parameters
| Name | Description |
|---|---|
|
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 director_search, 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 |
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 |
error_code |
Returns the error code when the status is |
t2a_version_number |
The current API version number. |
credit_used |
The number of credits used in order to execute the request. |
mode |
Returns |
director |
A single director record, populated with the full information about the individual. |
The values contained in the <director> element.
| Name | Description |
|---|---|
title |
The director's title, such as Mr, Mrs, Ms etc. |
forename |
The director's forename(s) |
middle_initial |
The director's middle initial or middle name (if available). |
surname |
The director's surname. |
name_single_line |
The director's full name as a single line, comprising title, forename, middle initial and surname; for example:- Mr Alan Fiction Jean A Dreamer |
nationality |
The country of nationality such as:- United Kingdom |
occupation |
The director's occupation |
line_1 |
The first line of the director's address |
line_2 |
The second line of the director's address |
line_3 |
The third line of the director's address |
place |
The place. If the director's address is in a named area within a large town, this will be that area, otherwise it will be the town. place is never empty if town is set. |
town |
The town; only used if the director's address is in a named area within that town. |
postcode |
The director's postcode, format with a space e.g. YO10 5NP |
addr_single_line |
The director's address as a single line. |
country_state_of_residence |
The director's country of residence. |
dob_details |
A Date Details node element detailing the director's date of birth if available. |
director_appt_list |
A list of Director Appt node instances. |
num_current_appt |
The number of current appointments. |
num_resigned_appt |
The number of resigned appointments. |
num_dissolved_appt |
The number of dissolved appointments. |
num_appt |
The total number of appointments. |
The values contained in the <director_appt> element.
| Name | Description |
|---|---|
company_name |
The company name. |
company_number |
The companies house number. |
company_status |
The current status. The defined values include:-
|
status |
The appointment status. The defined values include:-
|
type |
The appointment type, most commonly Director |
appointment_date |
The date of the director's appointment. In the format YYYY-MM-DD |
resignation_date |
The date of the director's resignation. In the format YYYY-MM-DD |
occupation |
The director's occupation within this appointment |
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.
