T2A
Click here for a complete list of operations.
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.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /soap/t2a.asmx HTTP/1.1 Host: api.t2a.io Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.t2a.io/soap/paf" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <paf xmlns="https://api.t2a.io/soap"> <api_key>string</api_key> <client>string</client> <postcode>string</postcode> <address>string</address> <records_per_page>string</records_per_page> <page_number>string</page_number> </paf> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <pafResponse xmlns="https://api.t2a.io/soap"> <pafResult> <address_list> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src xsi:nil="true" /> <data_src_text_list xsi:nil="true" /> <failsafe_reason>string</failsafe_reason> <geo_data xsi:nil="true" /> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src xsi:nil="true" /> <data_src_text_list xsi:nil="true" /> <failsafe_reason>string</failsafe_reason> <geo_data xsi:nil="true" /> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> </address_list> <street_list> <street> <name>string</name> <street_id>string</street_id> </street> <street> <name>string</name> <street_id>string</street_id> </street> </street_list> <place_list> <place> <name>string</name> </place> <place> <name>string</name> </place> </place_list> <num_street>string</num_street> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> </pafResult> </pafResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /soap/t2a.asmx HTTP/1.1 Host: api.t2a.io Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <paf xmlns="https://api.t2a.io/soap"> <api_key>string</api_key> <client>string</client> <postcode>string</postcode> <address>string</address> <records_per_page>string</records_per_page> <page_number>string</page_number> </paf> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <pafResponse xmlns="https://api.t2a.io/soap"> <pafResult> <address_list> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src xsi:nil="true" /> <data_src_text_list xsi:nil="true" /> <failsafe_reason>string</failsafe_reason> <geo_data xsi:nil="true" /> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src xsi:nil="true" /> <data_src_text_list xsi:nil="true" /> <failsafe_reason>string</failsafe_reason> <geo_data xsi:nil="true" /> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> </address_list> <street_list> <street> <name>string</name> <street_id>string</street_id> </street> <street> <name>string</name> <street_id>string</street_id> </street> </street_list> <place_list> <place> <name>string</name> </place> <place> <name>string</name> </place> </place_list> <num_street>string</num_street> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> </pafResult> </pafResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /soap/t2a.asmx/paf?api_key=string&client=string&postcode=string&address=string&records_per_page=string&page_number=string HTTP/1.1 Host: api.t2a.io
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <paf_res xmlns="https://api.t2a.io/soap"> <address_list> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src> <record_id>string</record_id> <src_code_list d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src> <data_src_text_list> <ALL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BT d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CH d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <RED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CD_HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_TEL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED_PUBLIC d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_NON_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BUS_MANUAL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src_text_list> <failsafe_reason>string</failsafe_reason> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src> <record_id>string</record_id> <src_code_list d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src> <data_src_text_list> <ALL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BT d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CH d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <RED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CD_HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_TEL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED_PUBLIC d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_NON_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BUS_MANUAL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src_text_list> <failsafe_reason>string</failsafe_reason> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> </address_list> <street_list> <street> <name>string</name> <street_id>string</street_id> </street> <street> <name>string</name> <street_id>string</street_id> </street> </street_list> <place_list> <place> <name>string</name> </place> <place> <name>string</name> </place> </place_list> <num_street>string</num_street> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> </paf_res>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /soap/t2a.asmx/paf HTTP/1.1 Host: api.t2a.io Content-Type: application/x-www-form-urlencoded Content-Length: length api_key=string&client=string&postcode=string&address=string&records_per_page=string&page_number=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <paf_res xmlns="https://api.t2a.io/soap"> <address_list> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src> <record_id>string</record_id> <src_code_list d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src> <data_src_text_list> <ALL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BT d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CH d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <RED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CD_HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_TEL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED_PUBLIC d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_NON_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BUS_MANUAL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src_text_list> <failsafe_reason>string</failsafe_reason> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> <address> <message>string</message> <share_id>string</share_id> <address_id>string</address_id> <line_1>string</line_1> <line_2>string</line_2> <line_3>string</line_3> <place>string</place> <town>string</town> <postcode>string</postcode> <addr_single_line>string</addr_single_line> <range_metres>string</range_metres> <status>string</status> <building>string</building> <street>string</street> <street2>string</street2> <premises>string</premises> <organisation>string</organisation> <organisation_key>string</organisation_key> <address_key>string</address_key> <england_wales>string</england_wales> <uprn>string</uprn> <rank>string</rank> <firstof>string</firstof> <home_type>string</home_type> <sale_price>string</sale_price> <sale_date>string</sale_date> <data_src> <record_id>string</record_id> <src_code_list d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src> <data_src_text_list> <ALL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BT d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CH d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <RED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CD_HIST d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_TEL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_ED_PUBLIC d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <HIST_ER_FULL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CS_NON_LTD d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <BUS_MANUAL d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </data_src_text_list> <failsafe_reason>string</failsafe_reason> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> <person>string</person> <person_landline>string</person_landline> <person_mobile>string</person_mobile> </address> </address_list> <street_list> <street> <name>string</name> <street_id>string</street_id> </street> <street> <name>string</name> <street_id>string</street_id> </street> </street_list> <place_list> <place> <name>string</name> </place> <place> <name>string</name> </place> </place_list> <num_street>string</num_street> <geo_data> <north>string</north> <east>string</east> <country_code>string</country_code> <country_name>string</country_name> <latitude>string</latitude> <longitude>string</longitude> <description>string</description> <postcode>string</postcode> <city>string</city> <accurate>string</accurate> <uprn>string</uprn> <uprn_enc>string</uprn_enc> <level>string</level> </geo_data> </paf_res>