ValidateAddress - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (SOAP)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (SOAP)
First publish date
2006

ValidateAddress standardizes and validates addresses using postal authority address data. It can correct information and format the address using the format preferred by the applicable postal authority. It also adds missing postal information, such as postal codes, city names, state/province names, and more.

ValidateAddress also returns result indicators about validation attempts, such as whether or not it validated the address, the level of confidence in the returned address, the reason for failure if the address could not be validated, and more.

During address matching and standardization, ValidateAddress separates address lines into components and compares them to the contents of the Universal Addressing Module databases. If a match is found, the input address is standardized to the database information. If no database match is found, it optionally formats the input addresses. The formatting process attempts to structure the address lines according to the conventions of the appropriate postal authority.

ValidateAddress is part of the Universal Addressing Module.

Resource URL

https://OnDemandServer/soap/ValidateAddress

For a list of Spectrum OnDemand servers, see Connecting to Spectrum OnDemand Servers.

Example

The following shows a SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:val="http://www.pb.com/spectrum/services/ValidateAddress">
<soapenv:Header/>
<soapenv:Body>
<val:ValidateAddressRequest>
<val:input_port>
<val:Address>
<!--Optional:-->
<val:AddressLine1>1 N. State St.</val:AddressLine1>
<!--Optional:-->
<val:AddressLine2></val:AddressLine2>
<!--Optional:-->
<val:AddressLine3></val:AddressLine3>
<!--Optional:-->
<val:AddressLine4></val:AddressLine4>
<!--Optional:-->
<val:AddressLine5></val:AddressLine5>
<!--Optional:-->
<val:City>Chicago</val:City>
<!--Optional:-->
<val:StateProvince></val:StateProvince>
<!--Optional:-->
<val:PostalCode></val:PostalCode>
<!--Optional:-->
<val:Country></val:Country>
<!--Optional:-->
<val:FirmName></val:FirmName>
<!--Optional:-->
<val:USUrbanName></val:USUrbanName>
<!--Optional:-->
<val:CanLanguage></val:CanLanguage>
<!--Optional:-->
<val:user_fields>
<val:user_field>
<val:name></val:name>
<val:value></val:value>
</val:user_field>
</val:user_fields>
</val:Address>
</val:input_port>
</val:ValidateAddressRequest>
</soapenv:Body>
</soapenv:Envelope>

This would be the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns3:ValidateAddressResponse xmlns:ns2="http://spectrum.pb.com/" xmlns:ns3="http://www.pb.com/spectrum/services/ValidateAddress">
         <ns3:output_port>
            <ns3:Address>
               <ns3:Confidence>87</ns3:Confidence>
               <ns3:RecordType>HighRise</ns3:RecordType>
               <ns3:RecordType.Default>Y</ns3:RecordType.Default>
               <ns3:CountryLevel>A</ns3:CountryLevel>
               <ns3:ProcessedBy>USA</ns3:ProcessedBy>
               <ns3:MatchScore>0</ns3:MatchScore>
               <ns3:AddressLine1>1 N State St</ns3:AddressLine1>
               <ns3:City>Chicago</ns3:City>
               <ns3:City.Result>V</ns3:City.Result>
               <ns3:StateProvince>IL</ns3:StateProvince>
               <ns3:StateProvince.Result>V</ns3:StateProvince.Result>
               <ns3:PostalCode>60602-3302</ns3:PostalCode>
               <ns3:PostalCode.Result>A</ns3:PostalCode.Result>
               <ns3:PostalCode.Source>FinanceNumber</ns3:PostalCode.Source>
               <ns3:PostalCode.Base>60602</ns3:PostalCode.Base>
               <ns3:PostalCode.AddOn>3302</ns3:PostalCode.AddOn>
               <ns3:Country>United States Of America</ns3:Country>
               <ns3:AdditionalInputData.Base/>
               <ns3:HouseNumber>1</ns3:HouseNumber>
               <ns3:HouseNumber.Result>V</ns3:HouseNumber.Result>
               <ns3:LeadingDirectional>N</ns3:LeadingDirectional>
               <ns3:LeadingDirectional.Result>V</ns3:LeadingDirectional.Result>
               <ns3:StreetName>State</ns3:StreetName>
               <ns3:StreetName.Result>V</ns3:StreetName.Result>
               <ns3:StreetName.PreferredAlias.Result/>
               <ns3:StreetName.AbbreviatedAlias.Result/>
               <ns3:StreetSuffix>St</ns3:StreetSuffix>
               <ns3:StreetSuffix.Result>V</ns3:StreetSuffix.Result>
               <ns3:TrailingDirectional/>
               <ns3:ApartmentLabel.Result>R</ns3:ApartmentLabel.Result>
               <ns3:ApartmentNumber/>
               <ns3:ApartmentNumber.Result>R</ns3:ApartmentNumber.Result>
               <ns3:RRHC/>
               <ns3:POBox/>
               <ns3:PrivateMailbox/>
               <ns3:HouseNumber.Input>1</ns3:HouseNumber.Input>
               <ns3:LeadingDirectional.Input>N</ns3:LeadingDirectional.Input>
               <ns3:StreetName.Input>State</ns3:StreetName.Input>
               <ns3:StreetSuffix.Input>St</ns3:StreetSuffix.Input>
               <ns3:City.Input>Chicago</ns3:City.Input>
               <ns3:PostalCode.Input/>
               <ns3:USBCCheckDigit>0</ns3:USBCCheckDigit>
               <ns3:PostalBarCode>99</ns3:PostalBarCode>
               <ns3:USCarrierRouteCode>C032</ns3:USCarrierRouteCode>
               <ns3:USFIPSCountyNumber>031</ns3:USFIPSCountyNumber>
               <ns3:USCountyName>Cook</ns3:USCountyName>
               <ns3:USCongressionalDistrict>07</ns3:USCongressionalDistrict>
               <ns3:USLOTCode>0002A</ns3:USLOTCode>
               <ns3:USLOTSequence>T9</ns3:USLOTSequence>
               <ns3:USLOTHex>E8</ns3:USLOTHex>
               <ns3:USAltAddr/>
               <ns3:USLastLineNumber>W12401</ns3:USLastLineNumber>
               <ns3:USFinanceNumber>161542</ns3:USFinanceNumber>
               <ns3:USLACS>N</ns3:USLACS>
               <ns3:DPV>D</ns3:DPV>
               <ns3:DPVFootnote>AAN1</ns3:DPVFootnote>
               <ns3:CMRA>U</ns3:CMRA>
               <ns3:POBoxOnlyDeliveryZone/>
               <ns3:RDI>B</ns3:RDI>
               <ns3:AddressBlock1>1 N STATE ST</ns3:AddressBlock1>
               <ns3:AddressBlock2>CHICAGO IL  60602-3302</ns3:AddressBlock2>
               <ns3:AddressBlock3>UNITED STATES OF AMERICA</ns3:AddressBlock3>
               <ns3:ProbableCorrectness>0</ns3:ProbableCorrectness>
               <ns3:Status.Code>UnableToDPVConfirm</ns3:Status.Code>
               <ns3:Status.Description>Missing Apt/Suite Number</ns3:Status.Description>
               <ns3:user_fields>
                  <ns3:user_field>
                     <ns3:name/>
                     <ns3:value/>
                  </ns3:user_field>
               </ns3:user_fields>
            </ns3:Address>
         </ns3:output_port>
      </ns3:ValidateAddressResponse>
   </soap:Body>
</soap:Envelope>