AddressValidation Web Service

AddressValidation

Click here for a complete list of operations.

Process

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 /webservice5/v4/addressvalidation.asmx HTTP/1.1
Host: validator5.addressdoctor.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://validator5.AddressDoctor.com/Webservice5/v4/Process"

<?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>
    <Process xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
      <login>string</login>
      <password>string</password>
      <parameters>
        <ProcessMode>string</ProcessMode>
        <ServiceParameters>
          <JobToken>string</JobToken>
          <CampaignId>string</CampaignId>
          <ReservedXml>string</ReservedXml>
          <UseTransactionPool>string</UseTransactionPool>
        </ServiceParameters>
        <ValidationParameters>
          <FormatType>string</FormatType>
          <FormatDelimiter>string</FormatDelimiter>
          <DefaultCountryISO3>string</DefaultCountryISO3>
          <ForceCountryISO3>string</ForceCountryISO3>
          <CountryType>string</CountryType>
          <CountryOfOriginISO3>string</CountryOfOriginISO3>
          <StreetWithNumber>boolean</StreetWithNumber>
          <FormatWithCountry>boolean</FormatWithCountry>
          <ElementAbbreviation>boolean</ElementAbbreviation>
          <PreferredScript>string</PreferredScript>
          <PreferredLanguage>string</PreferredLanguage>
          <AliasStreet>string</AliasStreet>
          <AliasLocality>string</AliasLocality>
          <GlobalCasing>string</GlobalCasing>
          <GlobalMaxLength>int</GlobalMaxLength>
          <GlobalPreferredDescriptor>string</GlobalPreferredDescriptor>
          <MatchingScope>string</MatchingScope>
          <MaxResultCount>int</MaxResultCount>
          <DualAddressPriority>string</DualAddressPriority>
          <StandardizeInvalidAddresses>boolean</StandardizeInvalidAddresses>
          <RangesToExpand>string</RangesToExpand>
          <FlexibleRangeExpansion>boolean</FlexibleRangeExpansion>
          <GeoCodingType>string</GeoCodingType>
          <MatchingAlternatives>string</MatchingAlternatives>
          <MatchingExtendedArchive>boolean</MatchingExtendedArchive>
          <DisableCertifiedModeISO3>string</DisableCertifiedModeISO3>
          <FormatMaxLines>int</FormatMaxLines>
          <FormatAddressComplete>string</FormatAddressComplete>
          <Standardizations>
            <Element>string</Element>
            <Casing>string</Casing>
            <MaxLength>int</MaxLength>
            <MaxItemCount>int</MaxItemCount>
          </Standardizations>
          <Standardizations>
            <Element>string</Element>
            <Casing>string</Casing>
            <MaxLength>int</MaxLength>
            <MaxItemCount>int</MaxItemCount>
          </Standardizations>
          <AdditionalInformationSet>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformationSet>
          <AdditionalInformationSet>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformationSet>
          <OutputOptions>
            <RecordId>string</RecordId>
            <Organization>string</Organization>
            <Department>string</Department>
            <Contact>string</Contact>
            <Email>string</Email>
            <Building>string</Building>
            <SubBuilding>string</SubBuilding>
            <Street>string</Street>
            <HouseNumber>string</HouseNumber>
            <DeliveryService>string</DeliveryService>
            <Locality>string</Locality>
            <PreferredLocality>string</PreferredLocality>
            <PostalCode>string</PostalCode>
            <Province>string</Province>
            <Country>string</Country>
            <Residue>string</Residue>
            <RecipientLines>string</RecipientLines>
            <DeliveryAddressLines>string</DeliveryAddressLines>
            <CountrySpecificLocalityLine>string</CountrySpecificLocalityLine>
            <FormattedAddress>string</FormattedAddress>
            <AddressComplete>string</AddressComplete>
            <AddressDetailed>string</AddressDetailed>
          </OutputOptions>
        </ValidationParameters>
      </parameters>
      <addresses>
        <Address>
          <RecordId>string</RecordId>
          <Organization>
            <string>string</string>
            <string>string</string>
          </Organization>
          <Department>
            <string>string</string>
            <string>string</string>
          </Department>
          <Contact>
            <string>string</string>
            <string>string</string>
          </Contact>
          <Email>
            <string>string</string>
            <string>string</string>
          </Email>
          <Building>
            <string>string</string>
            <string>string</string>
          </Building>
          <SubBuilding>
            <string>string</string>
            <string>string</string>
          </SubBuilding>
          <Street>
            <string>string</string>
            <string>string</string>
          </Street>
          <HouseNumber>
            <string>string</string>
            <string>string</string>
          </HouseNumber>
          <DeliveryService>
            <string>string</string>
            <string>string</string>
          </DeliveryService>
          <Locality>
            <string>string</string>
            <string>string</string>
          </Locality>
          <PreferredLocality>
            <string>string</string>
            <string>string</string>
          </PreferredLocality>
          <PostalCode>
            <string>string</string>
            <string>string</string>
          </PostalCode>
          <Province>
            <string>string</string>
            <string>string</string>
          </Province>
          <Country>
            <string>string</string>
            <string>string</string>
          </Country>
          <Residue>
            <string>string</string>
            <string>string</string>
          </Residue>
          <RecipientLines>
            <string>string</string>
            <string>string</string>
          </RecipientLines>
          <DeliveryAddressLines>
            <string>string</string>
            <string>string</string>
          </DeliveryAddressLines>
          <CountrySpecificLocalityLine>
            <string>string</string>
            <string>string</string>
          </CountrySpecificLocalityLine>
          <FormattedAddress>
            <string>string</string>
            <string>string</string>
          </FormattedAddress>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AddressComplete>string</AddressComplete>
          <AddressCode>
            <CodeType>string</CodeType>
            <Value>string</Value>
          </AddressCode>
          <AddressDetailed>
            <Organization xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Building xsi:nil="true" />
            <SubBuilding xsi:nil="true" />
            <Street xsi:nil="true" />
            <HouseNumber xsi:nil="true" />
            <DeliveryService xsi:nil="true" />
            <Locality xsi:nil="true" />
            <PostalCode xsi:nil="true" />
            <Province xsi:nil="true" />
            <Country xsi:nil="true" />
            <Residue xsi:nil="true" />
          </AddressDetailed>
        </Address>
        <Address>
          <RecordId>string</RecordId>
          <Organization>
            <string>string</string>
            <string>string</string>
          </Organization>
          <Department>
            <string>string</string>
            <string>string</string>
          </Department>
          <Contact>
            <string>string</string>
            <string>string</string>
          </Contact>
          <Email>
            <string>string</string>
            <string>string</string>
          </Email>
          <Building>
            <string>string</string>
            <string>string</string>
          </Building>
          <SubBuilding>
            <string>string</string>
            <string>string</string>
          </SubBuilding>
          <Street>
            <string>string</string>
            <string>string</string>
          </Street>
          <HouseNumber>
            <string>string</string>
            <string>string</string>
          </HouseNumber>
          <DeliveryService>
            <string>string</string>
            <string>string</string>
          </DeliveryService>
          <Locality>
            <string>string</string>
            <string>string</string>
          </Locality>
          <PreferredLocality>
            <string>string</string>
            <string>string</string>
          </PreferredLocality>
          <PostalCode>
            <string>string</string>
            <string>string</string>
          </PostalCode>
          <Province>
            <string>string</string>
            <string>string</string>
          </Province>
          <Country>
            <string>string</string>
            <string>string</string>
          </Country>
          <Residue>
            <string>string</string>
            <string>string</string>
          </Residue>
          <RecipientLines>
            <string>string</string>
            <string>string</string>
          </RecipientLines>
          <DeliveryAddressLines>
            <string>string</string>
            <string>string</string>
          </DeliveryAddressLines>
          <CountrySpecificLocalityLine>
            <string>string</string>
            <string>string</string>
          </CountrySpecificLocalityLine>
          <FormattedAddress>
            <string>string</string>
            <string>string</string>
          </FormattedAddress>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AddressComplete>string</AddressComplete>
          <AddressCode>
            <CodeType>string</CodeType>
            <Value>string</Value>
          </AddressCode>
          <AddressDetailed>
            <Organization xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Building xsi:nil="true" />
            <SubBuilding xsi:nil="true" />
            <Street xsi:nil="true" />
            <HouseNumber xsi:nil="true" />
            <DeliveryService xsi:nil="true" />
            <Locality xsi:nil="true" />
            <PostalCode xsi:nil="true" />
            <Province xsi:nil="true" />
            <Country xsi:nil="true" />
            <Residue xsi:nil="true" />
          </AddressDetailed>
        </Address>
      </addresses>
      <enrichments>
        <Enrichment>
          <Type>string</Type>
          <PayloadXml>string</PayloadXml>
        </Enrichment>
        <Enrichment>
          <Type>string</Type>
          <PayloadXml>string</PayloadXml>
        </Enrichment>
      </enrichments>
    </Process>
  </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>
    <ProcessResponse xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
      <ProcessResult>
        <StatusCode>int</StatusCode>
        <StatusMessage>string</StatusMessage>
        <JobToken>string</JobToken>
        <CampaignId>string</CampaignId>
        <ReservedXml>string</ReservedXml>
        <AdditionalInformationSet>
          <AdditionalInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformation>
          <AdditionalInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformation>
        </AdditionalInformationSet>
        <Results>
          <Result>
            <ProcessStatus>string</ProcessStatus>
            <ErrorMessage>string</ErrorMessage>
            <CountryISO3>string</CountryISO3>
            <ResultDataSet xsi:nil="true" />
            <Enrichments xsi:nil="true" />
          </Result>
          <Result>
            <ProcessStatus>string</ProcessStatus>
            <ErrorMessage>string</ErrorMessage>
            <CountryISO3>string</CountryISO3>
            <ResultDataSet xsi:nil="true" />
            <Enrichments xsi:nil="true" />
          </Result>
        </Results>
      </ProcessResult>
    </ProcessResponse>
  </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 /webservice5/v4/addressvalidation.asmx HTTP/1.1
Host: validator5.addressdoctor.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>
    <Process xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
      <login>string</login>
      <password>string</password>
      <parameters>
        <ProcessMode>string</ProcessMode>
        <ServiceParameters>
          <JobToken>string</JobToken>
          <CampaignId>string</CampaignId>
          <ReservedXml>string</ReservedXml>
          <UseTransactionPool>string</UseTransactionPool>
        </ServiceParameters>
        <ValidationParameters>
          <FormatType>string</FormatType>
          <FormatDelimiter>string</FormatDelimiter>
          <DefaultCountryISO3>string</DefaultCountryISO3>
          <ForceCountryISO3>string</ForceCountryISO3>
          <CountryType>string</CountryType>
          <CountryOfOriginISO3>string</CountryOfOriginISO3>
          <StreetWithNumber>boolean</StreetWithNumber>
          <FormatWithCountry>boolean</FormatWithCountry>
          <ElementAbbreviation>boolean</ElementAbbreviation>
          <PreferredScript>string</PreferredScript>
          <PreferredLanguage>string</PreferredLanguage>
          <AliasStreet>string</AliasStreet>
          <AliasLocality>string</AliasLocality>
          <GlobalCasing>string</GlobalCasing>
          <GlobalMaxLength>int</GlobalMaxLength>
          <GlobalPreferredDescriptor>string</GlobalPreferredDescriptor>
          <MatchingScope>string</MatchingScope>
          <MaxResultCount>int</MaxResultCount>
          <DualAddressPriority>string</DualAddressPriority>
          <StandardizeInvalidAddresses>boolean</StandardizeInvalidAddresses>
          <RangesToExpand>string</RangesToExpand>
          <FlexibleRangeExpansion>boolean</FlexibleRangeExpansion>
          <GeoCodingType>string</GeoCodingType>
          <MatchingAlternatives>string</MatchingAlternatives>
          <MatchingExtendedArchive>boolean</MatchingExtendedArchive>
          <DisableCertifiedModeISO3>string</DisableCertifiedModeISO3>
          <FormatMaxLines>int</FormatMaxLines>
          <FormatAddressComplete>string</FormatAddressComplete>
          <Standardizations>
            <Element>string</Element>
            <Casing>string</Casing>
            <MaxLength>int</MaxLength>
            <MaxItemCount>int</MaxItemCount>
          </Standardizations>
          <Standardizations>
            <Element>string</Element>
            <Casing>string</Casing>
            <MaxLength>int</MaxLength>
            <MaxItemCount>int</MaxItemCount>
          </Standardizations>
          <AdditionalInformationSet>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformationSet>
          <AdditionalInformationSet>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformationSet>
          <OutputOptions>
            <RecordId>string</RecordId>
            <Organization>string</Organization>
            <Department>string</Department>
            <Contact>string</Contact>
            <Email>string</Email>
            <Building>string</Building>
            <SubBuilding>string</SubBuilding>
            <Street>string</Street>
            <HouseNumber>string</HouseNumber>
            <DeliveryService>string</DeliveryService>
            <Locality>string</Locality>
            <PreferredLocality>string</PreferredLocality>
            <PostalCode>string</PostalCode>
            <Province>string</Province>
            <Country>string</Country>
            <Residue>string</Residue>
            <RecipientLines>string</RecipientLines>
            <DeliveryAddressLines>string</DeliveryAddressLines>
            <CountrySpecificLocalityLine>string</CountrySpecificLocalityLine>
            <FormattedAddress>string</FormattedAddress>
            <AddressComplete>string</AddressComplete>
            <AddressDetailed>string</AddressDetailed>
          </OutputOptions>
        </ValidationParameters>
      </parameters>
      <addresses>
        <Address>
          <RecordId>string</RecordId>
          <Organization>
            <string>string</string>
            <string>string</string>
          </Organization>
          <Department>
            <string>string</string>
            <string>string</string>
          </Department>
          <Contact>
            <string>string</string>
            <string>string</string>
          </Contact>
          <Email>
            <string>string</string>
            <string>string</string>
          </Email>
          <Building>
            <string>string</string>
            <string>string</string>
          </Building>
          <SubBuilding>
            <string>string</string>
            <string>string</string>
          </SubBuilding>
          <Street>
            <string>string</string>
            <string>string</string>
          </Street>
          <HouseNumber>
            <string>string</string>
            <string>string</string>
          </HouseNumber>
          <DeliveryService>
            <string>string</string>
            <string>string</string>
          </DeliveryService>
          <Locality>
            <string>string</string>
            <string>string</string>
          </Locality>
          <PreferredLocality>
            <string>string</string>
            <string>string</string>
          </PreferredLocality>
          <PostalCode>
            <string>string</string>
            <string>string</string>
          </PostalCode>
          <Province>
            <string>string</string>
            <string>string</string>
          </Province>
          <Country>
            <string>string</string>
            <string>string</string>
          </Country>
          <Residue>
            <string>string</string>
            <string>string</string>
          </Residue>
          <RecipientLines>
            <string>string</string>
            <string>string</string>
          </RecipientLines>
          <DeliveryAddressLines>
            <string>string</string>
            <string>string</string>
          </DeliveryAddressLines>
          <CountrySpecificLocalityLine>
            <string>string</string>
            <string>string</string>
          </CountrySpecificLocalityLine>
          <FormattedAddress>
            <string>string</string>
            <string>string</string>
          </FormattedAddress>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AddressComplete>string</AddressComplete>
          <AddressCode>
            <CodeType>string</CodeType>
            <Value>string</Value>
          </AddressCode>
          <AddressDetailed>
            <Organization xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Building xsi:nil="true" />
            <SubBuilding xsi:nil="true" />
            <Street xsi:nil="true" />
            <HouseNumber xsi:nil="true" />
            <DeliveryService xsi:nil="true" />
            <Locality xsi:nil="true" />
            <PostalCode xsi:nil="true" />
            <Province xsi:nil="true" />
            <Country xsi:nil="true" />
            <Residue xsi:nil="true" />
          </AddressDetailed>
        </Address>
        <Address>
          <RecordId>string</RecordId>
          <Organization>
            <string>string</string>
            <string>string</string>
          </Organization>
          <Department>
            <string>string</string>
            <string>string</string>
          </Department>
          <Contact>
            <string>string</string>
            <string>string</string>
          </Contact>
          <Email>
            <string>string</string>
            <string>string</string>
          </Email>
          <Building>
            <string>string</string>
            <string>string</string>
          </Building>
          <SubBuilding>
            <string>string</string>
            <string>string</string>
          </SubBuilding>
          <Street>
            <string>string</string>
            <string>string</string>
          </Street>
          <HouseNumber>
            <string>string</string>
            <string>string</string>
          </HouseNumber>
          <DeliveryService>
            <string>string</string>
            <string>string</string>
          </DeliveryService>
          <Locality>
            <string>string</string>
            <string>string</string>
          </Locality>
          <PreferredLocality>
            <string>string</string>
            <string>string</string>
          </PreferredLocality>
          <PostalCode>
            <string>string</string>
            <string>string</string>
          </PostalCode>
          <Province>
            <string>string</string>
            <string>string</string>
          </Province>
          <Country>
            <string>string</string>
            <string>string</string>
          </Country>
          <Residue>
            <string>string</string>
            <string>string</string>
          </Residue>
          <RecipientLines>
            <string>string</string>
            <string>string</string>
          </RecipientLines>
          <DeliveryAddressLines>
            <string>string</string>
            <string>string</string>
          </DeliveryAddressLines>
          <CountrySpecificLocalityLine>
            <string>string</string>
            <string>string</string>
          </CountrySpecificLocalityLine>
          <FormattedAddress>
            <string>string</string>
            <string>string</string>
          </FormattedAddress>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AdditionalAddressInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalAddressInformation>
          <AddressComplete>string</AddressComplete>
          <AddressCode>
            <CodeType>string</CodeType>
            <Value>string</Value>
          </AddressCode>
          <AddressDetailed>
            <Organization xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Building xsi:nil="true" />
            <SubBuilding xsi:nil="true" />
            <Street xsi:nil="true" />
            <HouseNumber xsi:nil="true" />
            <DeliveryService xsi:nil="true" />
            <Locality xsi:nil="true" />
            <PostalCode xsi:nil="true" />
            <Province xsi:nil="true" />
            <Country xsi:nil="true" />
            <Residue xsi:nil="true" />
          </AddressDetailed>
        </Address>
      </addresses>
      <enrichments>
        <Enrichment>
          <Type>string</Type>
          <PayloadXml>string</PayloadXml>
        </Enrichment>
        <Enrichment>
          <Type>string</Type>
          <PayloadXml>string</PayloadXml>
        </Enrichment>
      </enrichments>
    </Process>
  </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>
    <ProcessResponse xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
      <ProcessResult>
        <StatusCode>int</StatusCode>
        <StatusMessage>string</StatusMessage>
        <JobToken>string</JobToken>
        <CampaignId>string</CampaignId>
        <ReservedXml>string</ReservedXml>
        <AdditionalInformationSet>
          <AdditionalInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformation>
          <AdditionalInformation>
            <Name>string</Name>
            <Value>string</Value>
          </AdditionalInformation>
        </AdditionalInformationSet>
        <Results>
          <Result>
            <ProcessStatus>string</ProcessStatus>
            <ErrorMessage>string</ErrorMessage>
            <CountryISO3>string</CountryISO3>
            <ResultDataSet xsi:nil="true" />
            <Enrichments xsi:nil="true" />
          </Result>
          <Result>
            <ProcessStatus>string</ProcessStatus>
            <ErrorMessage>string</ErrorMessage>
            <CountryISO3>string</CountryISO3>
            <ResultDataSet xsi:nil="true" />
            <Enrichments xsi:nil="true" />
          </Result>
        </Results>
      </ProcessResult>
    </ProcessResponse>
  </soap12:Body>
</soap12:Envelope>