Documentation

T2A API Documentation

  1. Introduction
  2. General API Guide
    1. API Endpoint & Authentication
    2. Free Test Mode
    3. XML and JSON REST API Overview
    4. URL Encoding a GET Request
    5. SOAP API
    6. Using XML, JSON and SOAP Methods
    7. Asynchronous Methods
    8. Using Your Account Control Panel
    9. Security
  3. Code Examples
  4. XML, JSON and SOAP API Details
    1. General XML, JSON and SOAP Overview
    2. A JavaScript Key
    3. Security
    4. Invoking Methods
    5. Using T2A from JavaScript
    6. .NET Developers and the SOAP API
    7. Result Page Caching
    8. Common XML, JSON and SOAP Error Codes
    9. Common Response Structures
  5. Appendices
    1. ISO 3166-1 Country Codes
    2. Co-ordinate Systems
    3. Data Sources
    4. Company Categories
    5. Company Form Types
    6. Company Officer Disqualification Details
    7. Company Officer Types
    8. Company Statuses

XML and JSON REST API Overview

We offer an easy to use XML and JSON API. Requests may be made via POST or GET. The response is XML by default; adding the parameter output=json returns a JSON response. The XML and JSON API is available at:-

https://api.t2a.io/rest

The default XML response is shown below. Note the status and error code:-


<?xml version="1.0"?>
<T2A_Result>
  <mode>normal</mode>
  <status>error</status>
  <error_code>missing_method</error_code>
  <t2a_version_number>1.0.0</t2a_version_number>
</T2A_Result>

The default JSON response is shown below:-

{
  "mode":"normal",
  "status":"error",
  "error_code":"missing_method",
  "t2a_version_number":"1.0.0"
}

You can optionally specify a JSONP padding callback function in which the JSON is to be wrapped; the use of the parameter and values callback=myPadding is shown below:-

myPadding({
  "mode":"normal",
  "status":"error",
  "error_code":"missing_method",
  "t2a_version_number":"1.0.0"
});

Next: URL Encoding a GET Request