Identical to the ValidateAddressWithDPV operation but also returns RDI (Residential Delivery Indicator) data in the form of the “IsResidential” output node. Returns parsed and validated address elements including Delivery Point Validation.

URL Endpoints

ValidateAddressWithRDI Inputs

Name Type Description
Address String Address line of the address to validate.
For example, “123 Main Street”.
Address2 String The Address2 of the address to validate. This will only be used in particular situations where the Address1 does not help in validating the address.
City String The city of the address to validate.
For example, “New York”. The city isn’t required, but if one is not provided, the Zip code is required.
State String The state of the address to validate. For example, “NY”. This does not need to be contracted, full state names will work as well. The state isn’t required, but if one is not provided, the Zip code is required.
PostalCode String The zip code of the address to validate. A zip code isn’t required, but if one is not provided, the City and State are required.
LicenseKey* String Your license key to use the service.
Sign up for a free trial key at serviceobjects.com/address-validation

*this operation requires a special agreement with Service Objects.

ValidateAddressWithRDI Outputs

RDIAddressResponse

Name Type Values Description
RDIAddress RDIAddress Varies The corrected address.
Error Error Varies Error object indicating why the result was not returned. See Errors for more information.

RDIAddress

Name Type Values Description
Address String Varies The corrected Address line 1.
City String Varies The corrected city name.
State String Varies The corrected state name.
Zip String Varies The corrected zip code + 4.
Address2 String Varies The corrected Address line 2.
IsResidential String “True” or “False” Is the address a residence. If “false”, then it’s a business.
BarcodeDigits [1] String Varies

The post office delivery barcode digits.

Barcode Example: 931011445011

931011445011
Zip+4Deliver Point CodeChecksum Digit
CarrierRoute String 4 chars 4 chars: 1 for the route type, 3 for the route code. Identifies a group of addresses when prepended by 5-digit Zip.
CongressCode String Varies The congress code is the congressional district number.
CountyCode String Varies The county code of the given address.
CountyName String Varies The name of the county in which the given address lies.
FragmentHouse String Varies

The parsed house number of the given address.

123 in 123 North Main St West Apt A
FragmentPreDir String Varies

The parsed pre-directional of the address's street

North in 123 North Main St West Apt A
FragmentStreet String Varies

The parsed name of the street in the given address

Main in 123 North Main St West Apt A
FragmentSuffix String Varies

The parsed suffix of the street in the given address

St in 123 North Main St West Apt A
FragmentPostDir String Varies

The parsed post-directional of the address's street

West in 123 North Main St West Apt A
FragmentUnit String Varies The parsed unit type (e.g. “Apt” or “Ste”)
Fragment String Varies The parsed “Fragment” box, apartment or unit number. Same as FragmentPMBNumber.
FragmentPMBPrefix String Varies

The parsed type of the apartment, box, unit, etc

Apt in 123 North Main St West Apt A
FragmentPMBNumber String Varies

The parsed apartment, box, unit, etc. number of the given address.

123 in 123 North Main St West Apt A
DPV [2] String 1-4 Number that correlates to a DPV(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS.
DPVDesc String Varies Explains DPV result.
DPVNotes String Varies Number that correlates to DPV notes description. Service Objects may add or change Note descriptions, but will never modify existing codes.
DPVNotesDesc String Varies Details about the DPV result. Service Objects may add or change Note descriptions, but will never modify existing codes.
Corrections String Varies Number that correlates to a Corrections Description. Service Objects may add or change Correction descriptions, but will never modify existing codes.
CorrectionsDesc String Varies Description of what was corrected in an address. Service Objects may add or change Correction descriptions, but will never modify existing codes.

References

  1. ^ Address Deduplication Using USPS Barcodes
  2. ^ CASS and DPV: A Higher Standard for Address Accuracy