Sign up Login

View information about your account

API Method: client_info

Description

Provides information about your account like remaining credits.

This is a free method.

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.

Returned Values

The XML response is contained within a <client_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_balance

Your remaining credits.

total_credit_transactions

The number of times you have bought credits.

total_credits

The total number of credits that have been bought.

Error Codes

See the common error codes. There are no errors which are specific to this method.

Example XML Response


<?xml version="1.0"?>
<client_info_res>
	<mode>normal</mode>
	<status>ok</status>
	<credit_used>0</credit_used>
	<t2a_version_number>3.1.4.6</t2a_version_number>
	<credit_balance>127</credit_balance>
	<total_credit_transactions>2</total_credit_transactions>
	<total_credits>1700</total_credits>
</client_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)