ValidateMailingAddressUSCAN - Spectrum_OnDemand - main

Spectrum OnDemand Web Services (REST)

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

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.

Resource URL

JSON endpoint:

https://OnDemandServer/rest/ValidateMailingAddressUSCAN/results.json

XML endpoint:

https://OnDemandServer/rest/ValidateMailingAddressUSCAN/results.xml

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

Example with JSON Response

The following example requests a JSON response:

https://spectrum.precisely.com/rest/ValidateMailingAddressUSCAN/results.json?​Data.AddressLine1=​1700+District+Ave&Data.PostalCode=01803

The JSON returned by this request would be:

{
  "output_port": [
    {
      "Confidence": "100",
      "RecordType": "HighRise",
      "CountryLevel": "A",
      "MatchScore": "0",
      "USLACS": "N",
      "USLACS.ReturnCode": "",
      "RDI": "B",
      "AddressLine1": "1700 District Ave Ste 300",
      "City": "Burlington",
      "StateProvince": "MA",
      "PostalCode": "01803-5231",
      "PostalCode.Base": "01803",
      "PostalCode.AddOn": "5231",
      "Country": "United States Of America",
      "FirmName": "Precisely",
      "AddressBlock1": "Precisely",
      "AddressBlock2": "1700 District Ave Ste 300",
      "AddressBlock3": "Burlington Ma  01803-5231",
      "AddressBlock4": "United States Of America",
      "CanLanguage": "",
      "BlockAddress": "Precisely\n1700 District Ave Ste 300\nBurlington Ma  01803-5231\nUnited States Of America",
      "user_fields": [
        
      ]
    }
  ]
}

Example with XML Response

The following example requests an XML response:

https://spectrum.precisely.com/rest/ValidateMailingAddressUSCAN/results.xml?Data.AddressLine1=​1700+District+Ave&Data.PostalCode=01803

The XML returned by this request would be:

<xml.ValidateMailingAddressUSCANResponse xmlns="http://www.pb.com/spectrum/services/ValidateMailingAddressUSCAN">
 <output>
   <Row>
      <Confidence>100</Confidence>
      <RecordType>HighRise</RecordType>
      <CountryLevel>A</CountryLevel>
      <MatchScore>0</MatchScore>
      <USLACS>N</USLACS>
      <USLACS.ReturnCode/>
      <RDI>B</RDI>
      <AddressLine1>1700 District Ave Ste 300</AddressLine1>
      <City>Burlington</City>
      <StateProvince>MA</StateProvince>
      <PostalCode>01803-5231</PostalCode>
      <PostalCode.Base>01803</PostalCode.Base>
      <PostalCode.AddOn>5231</PostalCode.AddOn>
      <Country>United States Of America</Country>
      <FirmName>Precisely</FirmName>
      <AddressBlock1>Precisely</AddressBlock1>
      <AddressBlock2>1700 District Ave Ste 300</AddressBlock2>
      <AddressBlock3>Burlington Ma  01803-5231</AddressBlock3>
      <AddressBlock4>United States Of America</AddressBlock4>
      <CanLanguage/>
            <BlockAddress>Precisely
            1700 District Ave Ste 300
            Burlington Ma  01803-5231
            United States Of America</BlockAddress>
      <user_fields/>
   </Row>
 </Output>
</xml.ValidateMailingAddressUSCANResponse>