T2A Web Service

T2A

Click here for a complete list of operations.

director_search

Search the UK Companies House data for a company director or other company officer.

This returns an ID which can then be used with the 'director_details' method to obtain the full information on that individual.

You may choose to search for current officers or disqualified individuals.

The director search method returns the following information:-

Name
Postcode outer (e.g. YO10)
Date of birth
An ID to be used in the 'director_details' method to obtain the full information

Specify 'CUR' as the officer type for current company officers, or 'DIS' for disqualified persons.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
api_key:
client:
surname:
forename:
place:
officer_type:
page_id:
page_number:
records_per_page:
name:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.t2a.io/soap/director_search"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <director_search xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <surname>string</surname>
      <forename>string</forename>
      <place>string</place>
      <officer_type>string</officer_type>
      <page_id>string</page_id>
      <page_number>string</page_number>
      <records_per_page>string</records_per_page>
      <name>string</name>
    </director_search>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <director_searchResponse xmlns="https://api.t2a.io/soap">
      <director_searchResult>
        <place_list>
          <place>
            <name>string</name>
          </place>
          <place>
            <name>string</name>
          </place>
        </place_list>
        <director_list>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
        </director_list>
        <previous_page_id>string</previous_page_id>
        <next_page_id>string</next_page_id>
      </director_searchResult>
    </director_searchResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <director_search xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <surname>string</surname>
      <forename>string</forename>
      <place>string</place>
      <officer_type>string</officer_type>
      <page_id>string</page_id>
      <page_number>string</page_number>
      <records_per_page>string</records_per_page>
      <name>string</name>
    </director_search>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <director_searchResponse xmlns="https://api.t2a.io/soap">
      <director_searchResult>
        <place_list>
          <place>
            <name>string</name>
          </place>
          <place>
            <name>string</name>
          </place>
        </place_list>
        <director_list>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
        </director_list>
        <previous_page_id>string</previous_page_id>
        <next_page_id>string</next_page_id>
      </director_searchResult>
    </director_searchResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /soap/t2a.asmx/director_search?api_key=string&client=string&surname=string&forename=string&place=string&officer_type=string&page_id=string&page_number=string&records_per_page=string&name=string HTTP/1.1
Host: api.t2a.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<director_search_res xmlns="https://api.t2a.io/soap">
  <place_list>
    <place>
      <name>string</name>
    </place>
    <place>
      <name>string</name>
    </place>
  </place_list>
  <director_list>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
  </director_list>
  <previous_page_id>string</previous_page_id>
  <next_page_id>string</next_page_id>
</director_search_res>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx/director_search HTTP/1.1
Host: api.t2a.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

api_key=string&client=string&surname=string&forename=string&place=string&officer_type=string&page_id=string&page_number=string&records_per_page=string&name=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<director_search_res xmlns="https://api.t2a.io/soap">
  <place_list>
    <place>
      <name>string</name>
    </place>
    <place>
      <name>string</name>
    </place>
  </place_list>
  <director_list>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
  </director_list>
  <previous_page_id>string</previous_page_id>
  <next_page_id>string</next_page_id>
</director_search_res>