Downloading and Reviewing Address Validation File Results
Downloading Your File from the User Dashboard
If you uploaded your address verification file via the web interface, you will also be able to retrieve your file results directly from the dashboard. Simply scroll down to the bottom where it displays “Your Recent Batch Uploads” and click on “Download Now” or you can click on the 100% and it will also download your file.
You can also click on “View Statistics” to have it display an overview of your data results.
- Valid
- Invalid
- Unknown
Reviewing your file in Excel
When you open your file in excel you will notice that we have kept all the original columns of data you had, and added a few additional columns of data.
| Field | Description |
|---|---|
| status | A string describing the category of the address verification result. See our full List of Values. |
| reason | A short string that describes the specific reason for the “status” categorization. Refer to Address Verification Reasons for a full list of reasons and their descriptions. |
| corrected | Indicates if there was a material correction to the address, such as changing the street name, city or zip – true or false. In interactive use, you may want to confirm the corrected values with the user. |
| address1 | The standardized street address. |
| city | The standardized city name. |
| state | The two-letter abbreviation for the U.S. state or Canadian province. |
| zip | The U.S. five-digit zip code or the Canadian six-digit postal code for the address. |
| plus4 | The four-digit portion of a U.S. Zip+4. |
| urbanization | For certain addresses in Puerto Rico, this field will be returned with the name of the area the street is located in. See how to use it. |
| country | The two-character country abbreviation – “US” for United States or “CA” for Canada. |
| carrier_route | The four-character carrier route of a U.S. address. |
| delivery_point | A three-digit number that is the two-digit delivery point code combined with the delivery point check digit. You can construct a complete POSTNet barcode number by concatenating the zip, plus4 and delivery_point fields. |
| address_type | The type of the address. See the list of address types. |
| zip_type | For U.S. addresses, the type of zip code. See the list of zip types. |
| error | If there is a problem processing the request, this will contain a string that describes the error. See the list of errors. |
| duration | A floating point value of the number of seconds the server took to process the request. |
Address Status
Every postal address verification response will include one of the status values below:
| Status | Description |
|---|---|
| valid | The postal address is deliverable. |
| probably_valid | There are characteristics about the address that may cause delivery issues, but it is mostly likely deliverable. |
| possibly_valid | There are multiple or more serious factors that could cause delivery to the address to fail, but the address is still valid. |
| invalid | The address is not deliverable by the U.S.P.S. |
Address Reasons
The reason field will always be present in the response and describes the primary reason for the verification status. In the table below is our full list of address verification reasons, which status value it corresponds to and their descriptions.
| Status | Reason | Description |
|---|---|---|
| valid | deliverable | Input is or was converted to a valid postal address. |
| probably_valid | missing_secondary | Address is DPV confirmed for the primary address only, and secondary number information, such as a suite or apartment number, was missing. |
| probably_valid | invalid_secondary | Address is DPV confirmed for the primary address only, and secondary number information, such as a suite or apartment number, was present but unconfirmed. |
| probably_valid | usps_only | Address is DPV confirmed for an address that can only be serviced by the USPS, such as a P.O. Box or military address. |
| probably_valid | pbsa | Address is a DPV confirmed P.O. Box Street-Style Address. |
| probably_valid | cmra | Address is a DPV confirmed Commercial Mail Receiving Agency, such as a Mail Boxes, Etc. These addresses have higher turnover, and it is less likely for mail to be returned if the addressee no longer uses the CMRA. |
| probably_valid | vacant | Address is DPV confirmed, but is currently vacant (in most cases, unoccupied over 90 days) and not receiving delivery. Future mail may be received. |
| possibly_valid | missing_secondary | Address is DPV confirmed for the primary address only, and secondary number information, such as a suite or apartment number, was missing. See the “flags” field for additional reasons the address may not be deliverable. |
| possibly_valid | invalid_secondary | Address is DPV confirmed for the primary address only, and secondary number information, such as a suite or apartment number, was present but unconfirmed. See the “flags” field for additional reasons the address may not be deliverable. |
| possibly_valid | maildrop_or_inactive | Address is DPV confirmed but does not receive direct delivery because a) customer receives mail as a part of a drop; b) delivery has not been established, or c) the address is no longer a possible delivery because the carrier destroys or returns all of the mail. Some buildings, such as Xverify’s New York office, and multi-tenant residences receive mail as a drop. Therefore the post office does not have statistics on final delivery to the addressee, and it is less likely for mail to be returned if the addressee is no longer there. |
| possibly_valid | unique_zip | The zip code is assigned to a large organization or agency, and mail to that zip is routed by that organization. For unique zips, no validation is done on the street, city or state and it is very easy for bogus information to be entered. For example, 12345 is a unique zip and an address of NOT HERE, HEY, NY 12345 would be accepted. |
| possibly_valid | military_zip | Address is DPV confirmed for a military zip code. Final delivery to the addressee will be done by the military installation, and it is less likely for mail to be returned if the addressee no longer resides there. |
| possibly_valid | general_delivery | General Delivery is a mail service for those without a permanent address, often used as a temporary mailing address. Mail is held for the recipient for at most 30 days. |
| possibly_valid | missing_pmb | Address is for a CMRA (see above) but the Private Mail Box (PMB) number is missing, which makes delivery less likely. |
| possibly_valid | not_accessible | Address is DPV confirmed, but the USPS has flagged it as a place where carriers cannot physically access a building or door for mail delivery. Mail may not be delivered. |
| invalid | invalid_zip | The address could not be verified at the postal code level. |
| invalid | invalid_street | The street name could not be matched. |
| invalid | invalid_location | This address is not deliverable. |
| invalid | invalid_data | Minimum requirements for the address to be verified are not met. Check the content and formatting of the address. |
| invalid | invalid_primary | The house or building number for the address is not valid. |
| invalid | missing_primary | The house or building number is missing. |
| invalid | invalid_box | The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is invalid. |
| invalid | missing_box | The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is missing. |
| invalid | multiple_match | The address was matched to multiple records and there was not enough information to find a unique match. |
| invalid | ews_match | This address currently cannot be verified but was identified by the Early Warning System (EWS) as belonging to an upcoming area and may be deliverable in the future. |
| invalid | invalid_country | The address is for a country not-supported by this service. |
| invalid | non_usps | This US address is not serviced by the USPS, and a Plus4 could not be assigned, but it is possible that it may receive mail through third-party carriers like UPS. |
| unknown | no_result | A conclusive result could not be determined. |
Address Flags
The flags field is an array that may be populated with additional information about the address that may affect delivery. If a flag is a primary concern, it will appear in the reason field.
| flag | Description |
|---|---|
| cmra | Address is a DPV confirmed Commercial Mail Receiving Agency, such as a Mail Boxes, Etc. These addresses have higher turnover, and it is less likely for mail to be returned if the addressee no longer uses the CMRA. |
| pbsa | The address is P.O. Box using a Street-Style Address. |
| lacs_update | The address has been converted by LACSLink® from a rural-style address to a city-style address. |
| maildrop_or_inactive | Address does not receive direct delivery because a) customer receives mail as a part of a drop; b) delivery has not been established, or c) the address is no longer a possible delivery because the carrier destroys or returns all of the mail. Some buildings, such as Xverify’s New York office, and multi-tenant residences receive mail as a drop. Therefore the post office does not have statistics on final delivery to the addressee, and it is less likely for mail to be returned if the addressee is no longer there. |
| usps_only | The address can only be serviced by the USPS, such as a P.O. Box or military address. |
| vacant | Address is currently vacant (in most cases, unoccupied over 90 days) and not receiving delivery. Future mail may be received. |
| extra_text | Extraneous information not used in verifying the address was found. This includes unnecessary sub premises and other unrecognized data. If you use the “parsed=true” parameter, this additional information will either be placed into the secondary or extra_text output fields. |
Address types
The address_type field will be populated if the type of address has been categorized. The table below shows the full list of address types.
address_type values for U.S. addresses:
- Alias
- Firm
- General Delivery
- Highrise
- PO Box
- Rural Route
- Street
address_type values for Canadian addresses:
- Street
- Street Served by Route and GD
- Lock Box
- Route Service
- General Delivery
- LVR Street
- Government Street
- LVR Lock Box
- Government Lock Box
- LVR General Delivery
- Building
Zip types
The zip_type field will be populated if the input is a U.S. address, and the type of zip code has been categorized. Possible values are:
- PO Box
- Unique
- Military
- Standard
Error values
The error field will be populated if there is an error processing the request. These are string representations of the HTTP error codes below. Possible values are:
| Error | Description |
|---|---|
| invalid_api_key | The api_key provided is invalid. |
| inactive_service | Your api_key is not enabled for the service you are trying to use. For example, calling the address verification service when you are only setup for email verification. |
| missing_param | A required parameter is missing from your request. |
| limit_exceeded | Your API limit is exceeded. Please add funds or contact your account representative. |