ValidateMailingAddressUSCAN

ValidateMailingAddressUSCAN standardizes and validates addresses using US and Canada 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.

ValidateMailingAddressUSCAN 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, ValidateMailingAddressUSCAN 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.

ValidateMailingAddressUSCAN is part of the Universal Addressing Module.

The ValidateMailingAddressUSCAN API analyzes and compares the input addresses against the known address databases for US and CANADA only, to output standardized details along with DPV and RDI. It also returns parsed address fields and field validation codes. It corrects addresses, adds missing postal information, and formats the address per rules of the applicable postal authority.

Credit Calculation

0.33 credit is deducted for each address.

HTTP Method

POST

WSDL

https://api.precisely.com/identify/identifyaddress/v1/soap/validatemailingaddressuscan?wsdl

Resource URL

http://server:port/soap/ValidateAddress
https://OnDemandServer/soap/ValidateMailingAddressUSCAN
https://api.precisely.com/identify/identifyaddress/v1/soap/validatemailingaddressuscan

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/ValidateMailingAddressUSCAN">
   <soapenv:Header/>
   <soapenv:Body>
      <val:ValidateMailingAddressUSCANRequest>
         <val:Input>
            <!--Zero or more repetitions:-->
           <val:Address>
               <!--You may enter the following 11 items in any order-->
               <val:AddressLine1>1 Global View</val:AddressLine1>
               <val:AddressLine2></val:AddressLine2>
               <val:City>Troy</val:City>
               <val:StateProvince>NY</val:StateProvince>
               <val:PostalCode>01238</val:PostalCode>
               <val:Country>US</val:Country>
               <val:FirmName></val:FirmName>
               <val:USUrbanName></val:USUrbanName>
               <val:CanLanguage></val:CanLanguage>
               <val:InstanceKey></val:InstanceKey>
               <!--Optional:-->
               <val:user_fields>
                  <!--Zero or more repetitions:-->
                  <val:user_field>
                     <val:name></val:name>
                     <val:value></val:value>
                  </val:user_field>
               </val:user_fields>
            </val:Address>
         </val:Input>
      </val:ValidateMailingAddressUSCANRequest>
   </soapenv:Body>
</soapenv:Envelope>
<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>
               <val:AddressLine1>1 N. State St.</val:AddressLine1>
               <val:City>Chicago</val:City>
               <val:StateProvince>IL</val:StateProvince>
            </val:Address>
         </val:input_port>
      </val:ValidateAddressRequest>
   </soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:val="http://www.pb.com/spectrum/services/ValidateMailingAddressUSCANAPI">
		      <soapenv:Header/>
		      <soapenv:Body>
		      <val:ValidateMailingAddressUSCANAPIRequest>
		      <val:options>
		      <val:OutputCasing>M</val:OutputCasing>
		      <val:MaximumResults>10</val:MaximumResults>
		      
		      </val:options>
		      <!--Optional:-->
		      <val:Input>
		      
		      <val:Row>
		      
		      <val:City>Toronto</val:City>
		      
		      <val:StateProvince>ON</val:StateProvince>
		      
		      <val:PostalCode>M1V 1N4</val:PostalCode>
		      
		      <val:Country>CAN</val:Country>
		      
		      <val:AddressLine1>80 Dragoon Cres</val:AddressLine1>
		      
		      <val:user_fields>
		      <!--Zero or more repetitions:-->
		      <val:user_field>
		      <val:name></val:name>
		      <val:value></val:value>
		      </val:user_field>
		      </val:user_fields>
		      </val:Row>
		      </val:Input>
		      </val:ValidateMailingAddressUSCANAPIRequest>
		      </soapenv:Body>
		      </soapenv:Envelope>

This would be the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns3:ValidateMailingAddressUSCANResponse xmlns:ns2="http://spectrum.pb.com/" xmlns:ns3="http://www.pb.com/spectrum/services/ValidateMailingAddressUSCAN">
         <ns3:Output>
            <ns3:Address>
               <ns3:Confidence>88</ns3:Confidence>
               <ns3:RecordType>Normal</ns3:RecordType>
               <ns3:CountryLevel>A</ns3:CountryLevel>
               <ns3:ProcessedBy>USA</ns3:ProcessedBy>
               <ns3:MatchScore>0</ns3:MatchScore>
               <ns3:AddressLine1>1 Global View</ns3:AddressLine1>
               <ns3:AddressLine2/>
               <ns3:City>Troy</ns3:City>
               <ns3:City.Result>V</ns3:City.Result>
               <ns3:StateProvince>NY</ns3:StateProvince>
               <ns3:StateProvince.Result>V</ns3:StateProvince.Result>
              <ns3:PostalCode>01238</ns3:PostalCode>
               <ns3:PostalCode.Result>C</ns3:PostalCode.Result>
               <ns3:PostalCode.Source>FinanceNumber</ns3:PostalCode.Source>
               <ns3:Country>US</ns3:Country>
               <ns3:FirmName/>
               <ns3:HouseNumber.Result>V</ns3:HouseNumber.Result>
               <ns3:StreetName.Result>V</ns3:StreetName.Result>
               <ns3:StreetName.PreferredAlias.Result/>
               <ns3:StreetName.AbbreviatedAlias.Result/>
              <ns3:StreetSuffix.Result>S</ns3:StreetSuffix.Result>
               <ns3:USUrbanName/>
               <ns3:USLOTCode>0047A</ns3:USLOTCode>
               <ns3:USLOTSequence>K1</ns3:USLOTSequence>
               <ns3:USLOTHex>86</ns3:USLOTHex>
               <ns3:USLACS>N</ns3:USLACS>
               <ns3:USLACS.ReturnCode/>
               <ns3:DPV>Y</ns3:DPV>
               <ns3:DPVFootnote>AABB</ns3:DPVFootnote>
               <ns3:CMRA>N</ns3:CMRA>
               <ns3:POBoxOnlyDeliveryZone/>
               <ns3:RDI>B</ns3:RDI>
               <ns3:ProbableCorrectness>0</ns3:ProbableCorrectness>
               <ns3:user_fields>
                  <ns3:user_field>
                     <ns3:name/>
                     <ns3:value/>
                  </ns3:user_field>
               </ns3:user_fields>
            </ns3:Address>
         </ns3:Output>
      </ns3:ValidateMailingAddressUSCANResponse>
   </soap:Body>
</soap:Envelope>
<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:StateProvince>IL</ns3:StateProvince>
               <ns3:PostalCode>60602-3302</ns3:PostalCode>
               <ns3:PostalCode.Base>60602</ns3:PostalCode.Base>
               <ns3:PostalCode.AddOn>3302</ns3:PostalCode.AddOn>
               <ns3:Country>United States Of America</ns3:Country>
               <ns3:AdditionalInputData/>
               <ns3:user_fields/>
            </ns3:Address>
         </ns3:output_port>
      </ns3:ValidateAddressResponse>
   </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
		      <soap:Body>
		      <ns3:ValidateMailingAddressUSCANAPIResponse xmlns:ns3="http://www.pb.com/spectrum/services/ValidateMailingAddressUSCANAPI" xmlns:ns2="http://spectrum.pb.com/">
		      <ns3:Output>
		      <ns3:Row>
		      <ns3:Confidence>90</ns3:Confidence>
		      <ns3:RecordType>Normal</ns3:RecordType>
		      <ns3:CountryLevel>A</ns3:CountryLevel>
		      <ns3:AddressFormat>E</ns3:AddressFormat>
		      <ns3:AddressLine1>80 Dragoon Cres</ns3:AddressLine1>
		      <ns3:City>Toronto</ns3:City>
		      <ns3:StateProvince>ON</ns3:StateProvince>
		      <ns3:PostalCode>M1V 1N4</ns3:PostalCode>
		      <ns3:Country>Canada</ns3:Country>
		      <ns3:HouseNumber/>
		      <ns3:AddressBlock1>80 Dragoon Cres</ns3:AddressBlock1>
		      <ns3:AddressBlock2>Scarborough On  M1v 1n4</ns3:AddressBlock2>
		      <ns3:AddressBlock3>Canada</ns3:AddressBlock3>
		      <ns3:BlockAddress>80 Dragoon Cres
		      Scarborough On  M1v 1n4
		      Canada</ns3:BlockAddress>
		      <ns3:user_fields>
		      <ns3:user_field>
		      <ns3:name/>
		      <ns3:value/>
		      </ns3:user_field>
		      </ns3:user_fields>
		      </ns3:Row>
		      </ns3:Output>
		      </ns3:ValidateMailingAddressUSCANAPIResponse>
		      </soap:Body>
		      </soap:Envelope>