EwsLabelService


Click here for a complete list of operations.

ValidateAddress

Test

The test form is only available for requests from the local machine.

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 /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/ValidateAddress"

<?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>
    <ValidateAddress xmlns="www.envmgr.com/LabelService">
      <ValidateAddressRequest>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <Address>
          <Name>string</Name>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <Zip4>int</Zip4>
          <DeliveryPoint>int</DeliveryPoint>
          <PostalCode>string</PostalCode>
          <CountryCode>string</CountryCode>
          <Urbanization>string</Urbanization>
          <FullAddress>string</FullAddress>
        </Address>
      </ValidateAddressRequest>
    </ValidateAddress>
  </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>
    <ValidateAddressResponse xmlns="www.envmgr.com/LabelService">
      <ValidateAddressResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <Address>
          <Name>string</Name>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <Zip4>int</Zip4>
          <DeliveryPoint>int</DeliveryPoint>
          <PostalCode>string</PostalCode>
          <CountryCode>string</CountryCode>
          <Urbanization>string</Urbanization>
          <FullAddress>string</FullAddress>
        </Address>
        <AddressMatch>boolean</AddressMatch>
        <CityStateZipOK>boolean</CityStateZipOK>
        <ResidentialDeliveryIndicator>boolean</ResidentialDeliveryIndicator>
        <IsPOBox>boolean</IsPOBox>
        <CandidateAddresses>
          <Address>
            <Name>string</Name>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip4>int</Zip4>
            <DeliveryPoint>int</DeliveryPoint>
            <PostalCode>string</PostalCode>
            <CountryCode>string</CountryCode>
            <Urbanization>string</Urbanization>
            <FullAddress>string</FullAddress>
          </Address>
          <Address>
            <Name>string</Name>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip4>int</Zip4>
            <DeliveryPoint>int</DeliveryPoint>
            <PostalCode>string</PostalCode>
            <CountryCode>string</CountryCode>
            <Urbanization>string</Urbanization>
            <FullAddress>string</FullAddress>
          </Address>
        </CandidateAddresses>
        <StatusCodes>
          <footnotes>
            <Footnote xsi:nil="true" />
            <Footnote xsi:nil="true" />
          </footnotes>
          <dpvFootnotes>
            <DpvFootnote xsi:nil="true" />
            <DpvFootnote xsi:nil="true" />
          </dpvFootnotes>
          <ReturnCode>int</ReturnCode>
        </StatusCodes>
        <AddressCleansingResult>string</AddressCleansingResult>
        <VerificationLevel>string</VerificationLevel>
        <AddressCleansedHash>string</AddressCleansedHash>
      </ValidateAddressResponse>
    </ValidateAddressResponse>
  </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 /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.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>
    <ValidateAddress xmlns="www.envmgr.com/LabelService">
      <ValidateAddressRequest>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <Address>
          <Name>string</Name>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <Zip4>int</Zip4>
          <DeliveryPoint>int</DeliveryPoint>
          <PostalCode>string</PostalCode>
          <CountryCode>string</CountryCode>
          <Urbanization>string</Urbanization>
          <FullAddress>string</FullAddress>
        </Address>
      </ValidateAddressRequest>
    </ValidateAddress>
  </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>
    <ValidateAddressResponse xmlns="www.envmgr.com/LabelService">
      <ValidateAddressResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <Address>
          <Name>string</Name>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <Zip4>int</Zip4>
          <DeliveryPoint>int</DeliveryPoint>
          <PostalCode>string</PostalCode>
          <CountryCode>string</CountryCode>
          <Urbanization>string</Urbanization>
          <FullAddress>string</FullAddress>
        </Address>
        <AddressMatch>boolean</AddressMatch>
        <CityStateZipOK>boolean</CityStateZipOK>
        <ResidentialDeliveryIndicator>boolean</ResidentialDeliveryIndicator>
        <IsPOBox>boolean</IsPOBox>
        <CandidateAddresses>
          <Address>
            <Name>string</Name>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip4>int</Zip4>
            <DeliveryPoint>int</DeliveryPoint>
            <PostalCode>string</PostalCode>
            <CountryCode>string</CountryCode>
            <Urbanization>string</Urbanization>
            <FullAddress>string</FullAddress>
          </Address>
          <Address>
            <Name>string</Name>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip4>int</Zip4>
            <DeliveryPoint>int</DeliveryPoint>
            <PostalCode>string</PostalCode>
            <CountryCode>string</CountryCode>
            <Urbanization>string</Urbanization>
            <FullAddress>string</FullAddress>
          </Address>
        </CandidateAddresses>
        <StatusCodes>
          <footnotes>
            <Footnote xsi:nil="true" />
            <Footnote xsi:nil="true" />
          </footnotes>
          <dpvFootnotes>
            <DpvFootnote xsi:nil="true" />
            <DpvFootnote xsi:nil="true" />
          </dpvFootnotes>
          <ReturnCode>int</ReturnCode>
        </StatusCodes>
        <AddressCleansingResult>string</AddressCleansingResult>
        <VerificationLevel>string</VerificationLevel>
        <AddressCleansedHash>string</AddressCleansedHash>
      </ValidateAddressResponse>
    </ValidateAddressResponse>
  </soap12:Body>
</soap12:Envelope>