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.
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?_wadlResource URL
JSON endpoint:
http://server:port/rest/ValidateAddress/results.jsonhttps://OnDemandServer/rest/ValidateAddress/results.jsonhttps://api.precisely.com/identify/identifyaddress/v1/rest/validatemailingaddressuscan/results.jsonXML endpoint:
http://server:port/rest/ValidateAddress/results.xmlhttps://OnDemandServer/rest/ValidateAddress/results.xmlhttps://api.precisely.com/identify/identifyaddress/v1/rest/validatemailingaddressuscan/results.xmlFor 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=78758https://spectrum.precisely.com/rest/ValidateAddress/results.json?Data.AddressLine1=1825+Kramer+Ln&Data.PostalCode=78758{
"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": "Normal",
"CountryLevel": "A",
"ProcessedBy": "USA",
"MatchScore": "0",
"AddressLine1": "1825 Kramer Ln",
"City": "Austin",
"StateProvince": "TX",
"PostalCode": "78758-4260",
"Country": "United States Of America",
"PostalCode.Base": "78758",
"PostalCode.AddOn": "4260",
"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=78758https://spectrum.precisely.com/rest/ValidateAddress/results.xml?Data.AddressLine1=1825+Kramer+Ln&Data.PostalCode=78758<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:
<ns2:xml.ValidateAddressResponse xmlns:ns2="http://www.pb.com/spectrum/services/ValidateAddress">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>93</ns2:Confidence>
<ns2:RecordType>Normal</ns2:RecordType>
<ns2:CountryLevel>A</ns2:CountryLevel>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:MatchScore>0</ns2:MatchScore>
<ns2:AddressLine1>1825 Kramer Ln</ns2:AddressLine1>
<ns2:City>Austin</ns2:City>
<ns2:StateProvince>TX</ns2:StateProvince>
<ns2:PostalCode>78758-4260</ns2:PostalCode>
<ns2:PostalCode.Base>78758</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn>4260</ns2:PostalCode.AddOn>
<ns2:Country>United States Of America</ns2:Country>
<ns2:user_fields/>
</ns2:Address>
</ns2:output_port>
</ns2:xml.ValidateAddressResponse><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>