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

API Endpoint & Authentication

T2A offers XML / JSON and SOAP API endpoints to suit your development framework.

XML / JSON

https://api.t2a.io/rest/


Our XML / JSON endpoint will output a response in XML by default or JSON if the output parameter is set to json (see example below).


SOAP

https://api.t2a.io/soap/

API Key Authentication

All T2A methods require authentication using the mandatory input parameter api_key. An API Key must be obtained by signing up. If you've already registered, you can view your API key by logging in.

Your API key should not be disclosed to third parties, and should not be included in web pages; however, other security measures are available to prevent unauthorised use of your account.

Example request URL
The following is an example request using the XML / JSON endpoint with the mandatory api_key and output set to json:

https://api.t2a.io/rest/?method=area_code&api_key=YOUR_API_KEY&text=USER_INPUT&output=json

Next: Free Test Mode