PostcodeServices19 Web Service

PostcodeServices19

Click here for a complete list of operations.

GetAddressesForPostcode

This function is used to return a list of addresses for a specified UK postcode. Passing your own reference will enable the tracking of the lookup from within the epostcode portal

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 /uk/postcodeservices19.asmx HTTP/1.1
Host: ws.epostcode.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ws.epostcode.com/uk/postcodeservices19.asmx/GetAddressesForPostcode"

<?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>
    <GetAddressesForPostcode xmlns="https://ws.epostcode.com/uk/postcodeservices19.asmx">
      <Postcode>string</Postcode>
      <LicenceKey>string</LicenceKey>
      <YourReference>string</YourReference>
    </GetAddressesForPostcode>
  </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>
    <GetAddressesForPostcodeResponse xmlns="https://ws.epostcode.com/uk/postcodeservices19.asmx">
      <GetAddressesForPostcodeResult>
        <List>
          <AddressPremise>
            <Unique_Delivery_Point>string</Unique_Delivery_Point>
            <Organisation_Department>string</Organisation_Department>
            <Organisation>string</Organisation>
            <Sub_Building_Name>string</Sub_Building_Name>
            <Building_Name>string</Building_Name>
            <Number>string</Number>
            <Dependent_Street>string</Dependent_Street>
            <Street>string</Street>
            <Double_Dependent_Locality>string</Double_Dependent_Locality>
            <Dependent_Locality>string</Dependent_Locality>
            <Post_Town>string</Post_Town>
            <County_LocalAuthority>string</County_LocalAuthority>
            <County_Administrative>string</County_Administrative>
            <County_FormerPostal>string</County_FormerPostal>
            <County_Traditional>string</County_Traditional>
            <Country>string</Country>
            <Postcode>string</Postcode>
            <Post_Office_Box>string</Post_Office_Box>
            <User_Category>string</User_Category>
            <Mailsort_Sortcode>string</Mailsort_Sortcode>
            <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <FullAddress>string</FullAddress>
            <Return_Code>string</Return_Code>
          </AddressPremise>
          <AddressPremise>
            <Unique_Delivery_Point>string</Unique_Delivery_Point>
            <Organisation_Department>string</Organisation_Department>
            <Organisation>string</Organisation>
            <Sub_Building_Name>string</Sub_Building_Name>
            <Building_Name>string</Building_Name>
            <Number>string</Number>
            <Dependent_Street>string</Dependent_Street>
            <Street>string</Street>
            <Double_Dependent_Locality>string</Double_Dependent_Locality>
            <Dependent_Locality>string</Dependent_Locality>
            <Post_Town>string</Post_Town>
            <County_LocalAuthority>string</County_LocalAuthority>
            <County_Administrative>string</County_Administrative>
            <County_FormerPostal>string</County_FormerPostal>
            <County_Traditional>string</County_Traditional>
            <Country>string</Country>
            <Postcode>string</Postcode>
            <Post_Office_Box>string</Post_Office_Box>
            <User_Category>string</User_Category>
            <Mailsort_Sortcode>string</Mailsort_Sortcode>
            <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <FullAddress>string</FullAddress>
            <Return_Code>string</Return_Code>
          </AddressPremise>
        </List>
        <IsError>boolean</IsError>
        <IsTruncated>boolean</IsTruncated>
        <RecCount>string</RecCount>
        <ErrorMessage>string</ErrorMessage>
      </GetAddressesForPostcodeResult>
    </GetAddressesForPostcodeResponse>
  </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 /uk/postcodeservices19.asmx HTTP/1.1
Host: ws.epostcode.com
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>
    <GetAddressesForPostcode xmlns="https://ws.epostcode.com/uk/postcodeservices19.asmx">
      <Postcode>string</Postcode>
      <LicenceKey>string</LicenceKey>
      <YourReference>string</YourReference>
    </GetAddressesForPostcode>
  </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>
    <GetAddressesForPostcodeResponse xmlns="https://ws.epostcode.com/uk/postcodeservices19.asmx">
      <GetAddressesForPostcodeResult>
        <List>
          <AddressPremise>
            <Unique_Delivery_Point>string</Unique_Delivery_Point>
            <Organisation_Department>string</Organisation_Department>
            <Organisation>string</Organisation>
            <Sub_Building_Name>string</Sub_Building_Name>
            <Building_Name>string</Building_Name>
            <Number>string</Number>
            <Dependent_Street>string</Dependent_Street>
            <Street>string</Street>
            <Double_Dependent_Locality>string</Double_Dependent_Locality>
            <Dependent_Locality>string</Dependent_Locality>
            <Post_Town>string</Post_Town>
            <County_LocalAuthority>string</County_LocalAuthority>
            <County_Administrative>string</County_Administrative>
            <County_FormerPostal>string</County_FormerPostal>
            <County_Traditional>string</County_Traditional>
            <Country>string</Country>
            <Postcode>string</Postcode>
            <Post_Office_Box>string</Post_Office_Box>
            <User_Category>string</User_Category>
            <Mailsort_Sortcode>string</Mailsort_Sortcode>
            <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <FullAddress>string</FullAddress>
            <Return_Code>string</Return_Code>
          </AddressPremise>
          <AddressPremise>
            <Unique_Delivery_Point>string</Unique_Delivery_Point>
            <Organisation_Department>string</Organisation_Department>
            <Organisation>string</Organisation>
            <Sub_Building_Name>string</Sub_Building_Name>
            <Building_Name>string</Building_Name>
            <Number>string</Number>
            <Dependent_Street>string</Dependent_Street>
            <Street>string</Street>
            <Double_Dependent_Locality>string</Double_Dependent_Locality>
            <Dependent_Locality>string</Dependent_Locality>
            <Post_Town>string</Post_Town>
            <County_LocalAuthority>string</County_LocalAuthority>
            <County_Administrative>string</County_Administrative>
            <County_FormerPostal>string</County_FormerPostal>
            <County_Traditional>string</County_Traditional>
            <Country>string</Country>
            <Postcode>string</Postcode>
            <Post_Office_Box>string</Post_Office_Box>
            <User_Category>string</User_Category>
            <Mailsort_Sortcode>string</Mailsort_Sortcode>
            <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
            <Latitude_Degrees>string</Latitude_Degrees>
            <Longitude_Degrees>string</Longitude_Degrees>
            <IsError>boolean</IsError>
            <ErrorMessage>string</ErrorMessage>
            <FullAddress>string</FullAddress>
            <Return_Code>string</Return_Code>
          </AddressPremise>
        </List>
        <IsError>boolean</IsError>
        <IsTruncated>boolean</IsTruncated>
        <RecCount>string</RecCount>
        <ErrorMessage>string</ErrorMessage>
      </GetAddressesForPostcodeResult>
    </GetAddressesForPostcodeResponse>
  </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 /uk/postcodeservices19.asmx/GetAddressesForPostcode?Postcode=string&LicenceKey=string&YourReference=string HTTP/1.1
Host: ws.epostcode.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ListAllAddressPremises xmlns="https://ws.epostcode.com/uk/postcodeservices19.asmx">
  <List>
    <AddressPremise>
      <Unique_Delivery_Point>string</Unique_Delivery_Point>
      <Organisation_Department>string</Organisation_Department>
      <Organisation>string</Organisation>
      <Sub_Building_Name>string</Sub_Building_Name>
      <Building_Name>string</Building_Name>
      <Number>string</Number>
      <Dependent_Street>string</Dependent_Street>
      <Street>string</Street>
      <Double_Dependent_Locality>string</Double_Dependent_Locality>
      <Dependent_Locality>string</Dependent_Locality>
      <Post_Town>string</Post_Town>
      <County_LocalAuthority>string</County_LocalAuthority>
      <County_Administrative>string</County_Administrative>
      <County_FormerPostal>string</County_FormerPostal>
      <County_Traditional>string</County_Traditional>
      <Country>string</Country>
      <Postcode>string</Postcode>
      <Post_Office_Box>string</Post_Office_Box>
      <User_Category>string</User_Category>
      <Mailsort_Sortcode>string</Mailsort_Sortcode>
      <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <FullAddress>string</FullAddress>
      <Return_Code>string</Return_Code>
    </AddressPremise>
    <AddressPremise>
      <Unique_Delivery_Point>string</Unique_Delivery_Point>
      <Organisation_Department>string</Organisation_Department>
      <Organisation>string</Organisation>
      <Sub_Building_Name>string</Sub_Building_Name>
      <Building_Name>string</Building_Name>
      <Number>string</Number>
      <Dependent_Street>string</Dependent_Street>
      <Street>string</Street>
      <Double_Dependent_Locality>string</Double_Dependent_Locality>
      <Dependent_Locality>string</Dependent_Locality>
      <Post_Town>string</Post_Town>
      <County_LocalAuthority>string</County_LocalAuthority>
      <County_Administrative>string</County_Administrative>
      <County_FormerPostal>string</County_FormerPostal>
      <County_Traditional>string</County_Traditional>
      <Country>string</Country>
      <Postcode>string</Postcode>
      <Post_Office_Box>string</Post_Office_Box>
      <User_Category>string</User_Category>
      <Mailsort_Sortcode>string</Mailsort_Sortcode>
      <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <FullAddress>string</FullAddress>
      <Return_Code>string</Return_Code>
    </AddressPremise>
  </List>
  <IsError>boolean</IsError>
  <IsTruncated>boolean</IsTruncated>
  <RecCount>string</RecCount>
  <ErrorMessage>string</ErrorMessage>
</ListAllAddressPremises>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /uk/postcodeservices19.asmx/GetAddressesForPostcode HTTP/1.1
Host: ws.epostcode.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Postcode=string&LicenceKey=string&YourReference=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ListAllAddressPremises xmlns="https://ws.epostcode.com/uk/postcodeservices19.asmx">
  <List>
    <AddressPremise>
      <Unique_Delivery_Point>string</Unique_Delivery_Point>
      <Organisation_Department>string</Organisation_Department>
      <Organisation>string</Organisation>
      <Sub_Building_Name>string</Sub_Building_Name>
      <Building_Name>string</Building_Name>
      <Number>string</Number>
      <Dependent_Street>string</Dependent_Street>
      <Street>string</Street>
      <Double_Dependent_Locality>string</Double_Dependent_Locality>
      <Dependent_Locality>string</Dependent_Locality>
      <Post_Town>string</Post_Town>
      <County_LocalAuthority>string</County_LocalAuthority>
      <County_Administrative>string</County_Administrative>
      <County_FormerPostal>string</County_FormerPostal>
      <County_Traditional>string</County_Traditional>
      <Country>string</Country>
      <Postcode>string</Postcode>
      <Post_Office_Box>string</Post_Office_Box>
      <User_Category>string</User_Category>
      <Mailsort_Sortcode>string</Mailsort_Sortcode>
      <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <FullAddress>string</FullAddress>
      <Return_Code>string</Return_Code>
    </AddressPremise>
    <AddressPremise>
      <Unique_Delivery_Point>string</Unique_Delivery_Point>
      <Organisation_Department>string</Organisation_Department>
      <Organisation>string</Organisation>
      <Sub_Building_Name>string</Sub_Building_Name>
      <Building_Name>string</Building_Name>
      <Number>string</Number>
      <Dependent_Street>string</Dependent_Street>
      <Street>string</Street>
      <Double_Dependent_Locality>string</Double_Dependent_Locality>
      <Dependent_Locality>string</Dependent_Locality>
      <Post_Town>string</Post_Town>
      <County_LocalAuthority>string</County_LocalAuthority>
      <County_Administrative>string</County_Administrative>
      <County_FormerPostal>string</County_FormerPostal>
      <County_Traditional>string</County_Traditional>
      <Country>string</Country>
      <Postcode>string</Postcode>
      <Post_Office_Box>string</Post_Office_Box>
      <User_Category>string</User_Category>
      <Mailsort_Sortcode>string</Mailsort_Sortcode>
      <Delivery_Point_Suffix>string</Delivery_Point_Suffix>
      <Latitude_Degrees>string</Latitude_Degrees>
      <Longitude_Degrees>string</Longitude_Degrees>
      <IsError>boolean</IsError>
      <ErrorMessage>string</ErrorMessage>
      <FullAddress>string</FullAddress>
      <Return_Code>string</Return_Code>
    </AddressPremise>
  </List>
  <IsError>boolean</IsError>
  <IsTruncated>boolean</IsTruncated>
  <RecCount>string</RecCount>
  <ErrorMessage>string</ErrorMessage>
</ListAllAddressPremises>

Parameter	Value
Postcode:
LicenceKey:
YourReference: