Version 3.8.0.2a

A powerful API for finding, verifying and validating data.

The following operations are supported. For a formal definition, please review the Service Description.

• address_geo_code
  Returns accurate co-ordinates of an address in England, Wales or Scotland. This returns OSGB36 Eastings and Northings (X,Y in metres) and WGS84 (used by GPS) Latitude and Longitude co-ordinates.
• address_person
  Enter a postcode and a premises (house name or number) to obtain the names and telephone numbers of all residents. If you enter only a postcode it will return a list of addresses; it will also do so when a postcode and premises is not unique.
• address_search
  Return UK postcodes or addresses using the Royal Mail Postal Address File (address_search) data. Returns address(es) using a postal code if supplied, or address(es) and postcode(s) using address information supplied.
• age_verification
  Validate that a given UK resident is aged 18 years or older.
• area_code
  Returns telephone area codes for specified location and vise versa. Enter the ISO 3166-1 two-character country code; currently only GB is supported.
  
  Examples:-
  
  (1) Enter 'LS'.
  (2) Enter '0113'.
  (3) Enter 'york*'.
• business_search
  Find a business by entering name and location.
• client_info
  View information about your account like remaining credits
• company_appointments
  Obtain a list of the officer appointments for a UK company.
  
  Using a full company number, this method returns a list of the appointments of company directors, secretaries and other officers.
  
  The data for each individual includes:-
  
  
  • Full address
  • Date of birth
  • Type of appointment
  • Director ID (can be used in the 'director_details' method)
• company_credit_report
  Get a credit report on a UK limited company
• company_details
  Obtain basic details on a UK company.
  
  Using a full company number, this method returns basic details on the company, including the registered address and current status.
• company_document
  Obtain information on a company document.
  
  Using a unique ID obtained from the filing history, obtain information on a company document. Part of this information includes a key to request a download of the document in the document download method.
• company_document_info
  Obtain information on a company document.
  
  Using a unique ID obtained from the filing history, obtain information on a company document. Part of this information includes a key to request a download of the document in the document download method.
• company_filing_history
  Obtain the filing history for a UK company.
  
  Using a full company number, this method returns the filing history for the company.
  
  Each item contains an 'image key' which may be optionally used with the 'company_document_info' method.
• company_mortgage_index
  Obtain the mortgage charge information for a UK company.
  
  Using a full company number, this method returns a list of charges past and present against the company.
  
  The information includes the name of the person or body entitled to that charge, the status of the charge, and the relevant dates.
• company_name_check
  Checks if a proposed company name is already registered, or if there is an existing company name which is too similar to the proposed name, under the Companies House 2006 regulations.
  
  For example, a name check on “Simunix Wholesellers” will return “no match”, but a name check on “Simunix International” will return “Simunix Limited” because the proposed name is too similar to the latter.
• company_name_search
  Search the UK Companies House data for a UK company by name.
  
  This returns a company number which can then be used with the 'Company Details' and other methods to obtain the full information on that organisation.
  
  You may choose to search for present, past and proposed companies.
• company_number_search
  Check a full or partial company number.
  
  This service can be used to validate a full or partial company number, or to obtain a list of possible matches.
  
  The method returns actual company numbers that may be used in conjunction the other company information methods.
• country_dial
  Find an international dialling code or determine the area(s) an international telephone dialling code represents. Enter the country name, or the dialling code.
  
  Examples:-
  
  (1) Enter '44' will return 'GB'.
  (2) Enter 'sao' to return '239',the dialling code for São Tomé and Príncipe.
• ctps
  Determine if a UK business landline or mobile number is registered in the Corporate Telephone Preference Scheme (CTPS). Returns 'no_call' if the number may not receive unsolicited marketing calls, or 'call' if the number is not registered with CTPS.
• deceased
  Check your data against our deceased persons data.
  
  This method is used to screen your existing data against our deceased persons data.
  
  Use this service to ensure contact with deceased persons is not attempted. This will help to minimise the distress caused to relatives and help your organisation avoid any negative publicity.
  
  Where available, the method returns the date of death.
• deceased_bulk
  Check multiple persons in your data against our deceased persons data.
  
  This method is used to screen your existing data against our deceased persons data.
  
  Use this service to ensure contact with deceased persons is not attempted. This will help to minimise the distress caused to relatives and help your organisation avoid any negative publicity.
  
  Where available, the method returns the date of death.
  
  Send your CSV data to this method, specifying the surname,forename and address columns. T2A will process the data, and inform you how many persons in you data are deceased. You may then choose to download an appended version of your CSV indicating which records are in our deceased register, and date of death where available
• director_details
  Obtain full details on a UK company director or other company officer.
• 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.
• electoral_roll
  Search the current edited electoral roll. Specify a full or partial surname and forename, and the U.K. place (or postcode) and full or partial address details, or enter an empty place for a UK-wide search.
  
  Alternatively enter a place and full or partial address to return persons at the given address.
• find_my_nearest
  Return the nearest records from client data list. 'group_id' is your predefined group identifier, or leave blank to use the default group id.
• full_electoral_roll
  Search the current full electoral roll. This is only available to permitted clients. Specify a full or partial surname and forename, and the U.K. place (or postcode) and full or partial address details, or enter an empty place for a UK-wide search.
  
  Alternatively enter a place and full or partial address to return persons at the given address.
• geo_code
  Returns approximate geographical co-ordinates of a postcode, street or place. For GB data returns OSGB36 Eastings and Northings (X,Y in metres) and WGS84 (used by GPS) Latitude and Longitude co-ordinates. United Kingdom data only available.
• geo_code_telephone
  Returns approximate geographical area of a telephone number. For GB data returns OSGB36 Eastings and Northings (X,Y in metres) and WGS84 (used by GPS) Latitude and Longitude co-ordinates. Enter the ISO 3166-1 two-character country code; currently only GB is supported.
• ip_country
  Returns the country in which an IP address is located. IPV4 supported currently. Returns ISO 3166-1 two character code.
• ip_location
  Returns the country code and approximate geo information on an IP address is located. IPV4 supported currently. Returns ISO 3166-1 two character code.
• javascript_key
  Generate a key to allow your web page to securely access T2A using Javascript.
  
  Returns a secure key which can be safely embedded in dynamic HTML markup to allow JavaScript access to T2A functions.
  
  You must specify a maximum lifetime for the key in minutes (up to 24 hours), and your website domain in which it will be used (e.g. www.mywebsite.com) and can optionally specify the remote IP address from which it can only be used (i.e. the user's IP address).
  
  These security measures ensure that the JavaScript key can only be used in your website by your designated users.
• job_create
  Create a T2A asynchronous job
• job_progress
  Read the percentage progress on a T2A asynchronous job
• paf
  Return UK postcodes or addresses using the Royal Mail Postal Address File (PAF) data. Returns address(es) using a postal code if supplied, or address(es) and postcode(s) using address information supplied.
• people_search
  Find UK people. Secify the full name and the U.K. place (or postcode) and full or partial address details, or enter an empty place for a UK-wide search.
  
  Alternatively enter a place and full or partial address to return persons at the given address.
• person_details
  Get full details on a UK person. Use a person_id supplied by the person_search method.
• person_search
  Find UK person. Secify the full name and the U.K. place (or postcode) and full or partial address details, or enter an empty place for a UK-wide search.
  
  Alternatively enter a place and full or partial address to return persons at the given address.
• person_verify
  Validate that a given person exists in our current UK person database.
• person_verify_historic
  Validate that a given person exists in our current AND historic UK person database.
• place_name
  Verify a place name.
  
  Only U.K. places currently supported.
• reverse_geo_code
  Enter a latitude and longitude to find the nearest address.
• send_text_message
  Sends a text message (SMS) to a mobile telephone.
• telephone_business
  Find a business telephone number by entering name and location.
• telephone_business_class
  Find a business telephone number by entering name or classification, and a location
• telephone_residential
  Find a residential telephone number by entering the surname and place name (or postcode).
  
  You may optionally enter the premises (i.e. the building number or name), the street name, or the person's forname.
• tps
  Determine if a UK residential landline or mobile number is registered in the Telephone Preference Scheme (TPS). Returns 'no_call' if the number may not receive unsolicited marketing calls, or 'call' if the number is not registered with TPS.
• tps_bulk
  Check multiple UK landline and/or mobile business and/or residential telephone numbers. This service will find any UK telephone numbers in an uploaded CSV and check against the TPS and CTPS registers.
• tps_full
  Determine if a UK landline or mobile number is registered in EITHER the Telephone Preference Scheme (TPS) or the business version (CTPS). Returns 'no_call' if the number may not receive unsolicited marketing calls, or 'call' if the number is not registered with TPS.
• validate_credit_card
  Validate a credit_card number
• validate_email
  Validate an email address. Reports if email format is valid, and checks that the domain is valid, and returns the mail server from the MX record.
• validate_mobile_phone_number
  Validate a UK mobile phone number. Returns the current network, original network (if ported) and flags to indicate if currently live or known to be ceased.
• validate_person
  Validate a UK resident using name, address, postcode and optionally DOB and telephone.
  The fuzzy and initial_match flags are on by default (set to 'false' or 'n' to disable).
  Postcode fuzziness extends to the final character of the UK postcode.
• validate_telephone
  Validate a UK telephone number. This onky checks that the number appears to be valid, and if so, returns the riginal network pr provider.
• validate_vat
  Validate a Value Added Tax (VAT) registration number. Only U.K. VAT numbers supported.