Sign up Login

Get Information on a Company Document

API Method: company_document_info

Description

This Service allows you to request information on the availability of a document to order by invoking the Document Info service. The image system provides mass storage for images of documents in multi page TIFF format.

This method returns a request key which is then submitted to the company_document method.

Please note that no data and document options are available for company numbers with the following prefixes:- IC, IP, LP, NP, NR, RC, SI, SL, SP, SR.

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.
company_number The Companies House company number.
image_key The image key as returned by the filing history.

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_document_info_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.
document A company document instance.

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_document_info_res>
  <mode>normal</mode>
  <t2a_version_number>3.1.2.8</t2a_version_number>
  <status>ok</status>
  <document>
    <company_number>03684982</company_number>
    <form_type>AA</form_type>
    <num_pages>4</num_pages>
    <made_up_date>2010-12-31</made_up_date>
    <media>CACHE</media>
    <doc_request_key>zXxsW-2RPaiS8RhKcDWXdXiJ_cmxEOZgEqlXisx2lfzKSd3ctekQZZKhivLBaQTIdRf5KFJt4g-EGm92AhsI5DzqPo3jutX5iZl88fUChJBkzm4NtLXb8H7pbYFdo4yeF-_qKDnlCAGBk4PrUw9mm2c_z</doc_request_key>
  </document>
</company_document_info_res>

Looking for the old documentation? Download it here (PDF format)

API Method List

< Back to T2A API Documentation

  1. Search for a person (person_search)
  2. Find people at an address (address_person)
  3. Search the UK Electoral Roll (electoral_roll)
  4. Search the Full UK Electoral Roll (full_electoral_roll)
  5. Search for a residential telephone number (telephone_residential)
  6. Search for a business (business_search)
  7. Search for an address/postcode (address_search)
  8. Validate a telephone number (validate_telephone)
  9. Validate a mobile telephone number (validate_mobile_phone_number)
  10. Validate a credit card number (validate_credit_card)
  11. Validate an email address (validate_email)
  12. Validate a VAT number (validate_vat)
  13. TPS/CTPS check a telephone number (tps_full)
  14. Find UK dialling codes (area_code)
  15. Find international dialling codes (country_dial)
  16. Geo-Code an address (geo_code)
  17. Reverse Geo-Code (reverse_geo_code)
  18. Find company details (company_details)
  19. Find director details (director_details)
  20. Get a company credit report (company_credit_report)
  21. Find a location from an IP address (ip_location)
  22. Send a text message (send_text_message)
  23. Check the bereavement register (deceased)
  24. Bulk check the bereavement register (deceased_bulk)
  25. Check company name availability (company_name_check)
  26. Download a company document (company_document_download)
  27. Generate a secure JavaScript key (javascript_key)
  28. Create an asynchronous job (job_create)
  29. Read the progress of an asynchronous job (job_progress)
  30. Telephone number appending (tele_append)
  31. View information about your account (client_info)