ValidateMailingAddressUSCAN - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

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

WADL

https://api.precisely.com/identify/identifyaddress/v1/rest/validatemailingaddressuscan?_wadl

Resource URL

JSON endpoint:

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

XML endpoint:

http://server:port/rest/ValidateAddress/results.xml
https://OnDemandServer/rest/ValidateMailingAddressUSCAN/results.xml
https://api.precisely.com/identify/identifyaddress/v1/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:

http://myserver:8080/rest/ValidateAddress/results.json?​Data.AddressLine1=​1825+Kramer+Ln&Data.PostalCode=78758
https://spectrum.precisely.com/rest/ValidateMailingAddressUSCAN/results.json?​Data.AddressLine1=​1700+District+Ave&Data.PostalCode=01803
{
		      "options": {
		      "OutputCasing": "M",
		      "OutputFieldLevelReturnCodes": "Y"
		      },
		      "Input": {
		      "Row": [
		      {
		      "AddressLine1": "1 N. State St.",
		      "City": "Chicago",
		      "StateProvince":"IL",
		      "Country": "us"
		      }
		      ]
		      }
		      }

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": [
        
      ]
    }
  ]
}
{"Output": [{
		      "Status.Code": "UnableToDPVConfirm",
		      "Status.Description": "Missing Apt/Suite Number",
		      "Confidence": "87",
		      "RecordType": "HighRise",
		      "RecordType.Default": "Y",
		      "CountryLevel": "A",
		      "MatchScore": "0",
		      "USLACS": "N",
		      "USLACS.ReturnCode": "",
		      "RDI": "B",
		      "CMRA": "U",
		      "DPV": "D",
		      "DPVFootnote": "AAN1",
		      "AddressLine1": "1 N State St",
		      "City": "Chicago",
		      "StateProvince": "IL",
		      "PostalCode": "60602-3302",
		      "PostalCode.Base": "60602",
		      "PostalCode.AddOn": "3302",
		      "Country": "United States Of America",
		      "HouseNumber.Result": "V",
		      "LeadingDirectional.Result": "V",
		      "StreetName.Result": "V",
		      "StreetSuffix.Result": "V",
		      "ApartmentLabel.Result": "R",
		      "ApartmentNumber.Result": "R",
		      "City.Result": "V",
		      "StateProvince.Result": "V",
		      "PostalCode.Result": "A",
		      "PostalCode.Source": "FinanceNumber",
		      "AddressBlock1": "1 N State St",
		      "AddressBlock2": "Chicago Il  60602-3302",
		      "AddressBlock3": "United States Of America",
		      "BlockAddress": "1 N State St\nChicago Il  60602-3302\nUnited States Of America",
		      "user_fields": []
		      }]}

Example with XML Response

The following example requests an XML response:

http://myserver:8080/rest/ValidateAddress/results.xml?Data.AddressLine1=​1825+Kramer+Ln&Data.PostalCode=78758
https://spectrum.precisely.com/rest/ValidateMailingAddressUSCAN/results.xml?Data.AddressLine1=​1700+District+Ave&Data.PostalCode=01803
<ValidateMailingAddressUSCANAPIRequest>          
            <options>             
            <KeepMultimatch>N</KeepMultimatch>
            <OutputCasing></OutputCasing>
            </options>          
            <Input>           
            <Row>  
            <City>ETOBICOKE</City>                
            <StateProvince>ON</StateProvince>                
            <PostalCode></PostalCode>                
            <Country>CAN</Country>                
            <AddressLine1>PO BOX #35 STN</AddressLine1>                
            
            <user_fields>                  
            <user_field>
            <name></name>
            <value></value>
            </user_field>
            </user_fields>
            </Row>
            </Input>
            </ValidateMailingAddressUSCANAPIRequest>

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>
<xml.ValidateMailingAddressUSCANAPIResponse xmlns="http://www.pb.com/spectrum/services/ValidateMailingAddressUSCANAPI">
            <Output>
            <Row>
            <Status>F</Status>
            <Status.Code>MultipleMatchesFound</Status.Code>
            <Status.Description>Possible Multiple Adresses Found</Status.Description>
            <Confidence>0</Confidence>
            <MultipleMatches>PostalCode</MultipleMatches>
            <CountryLevel>A</CountryLevel>
            <AddressLine1>PO Box #35 Stn</AddressLine1>
            <City>Etobicoke</City>
            <StateProvince>ON</StateProvince>
            <PostalCode/>
            <Country>Canada</Country>
            <HouseNumber/>
            <StreetName>Po Box</StreetName>
            <ApartmentNumber/>
            <AddressBlock1>Po Box #35 Stn</AddressBlock1>
            <AddressBlock2>Etobicoke On</AddressBlock2>
            <AddressBlock3>Canada</AddressBlock3>
            <BlockAddress>Po Box #35 Stn
            Etobicoke On
            Canada</BlockAddress>
            <user_fields/>
            </Row>
            </Output>
            </xml.ValidateMailingAddressUSCANAPIResponse>