field-definitions

SmartyStreets Wiki

 

Field Definition Guide

Addon Code

Contains the four-digit (+4) add-on code (if processed successfully) returned for the submitted address.

Addressee

The intended recipient at a specified address.

All Input Fields

Each of the fields in your list is preserved in the everything file. You can identify them because they will be wrapped in brackets ('[]'). If your file did not have column headers these field names will be generated by our system (ie. 'Field0', 'Field1', 'Field2', etc…).

Building Default Indicator

Indicates Whether or not the address is the 'default' address for a building. This could be the main lobby.

Candidate Index

An address can have multiple candidate addresses. This ties the candidates to the input index.

Carrier Route

Contains the postal carrier route for the submitted address.

Check Digit

Contains the check digit (i.e. correction character) for the 11-digit delivery point barcode (DPBC).

City

Contains the accepted city name returned for the submitted address.

City Name

Same as City.

CMRA Code

Indicates whether or not the address is associated with a Commercial Mailing Receiving Agency (CMRA), also known as a private mail box operator. A CMRA is a business through which USPS mail may be sent or received. The UPS Store and Mailboxes Etc. are examples of a CMRA. A private mail box (PMB) is usually associated with a CMRA. The following is a list of all CMRA fields listed with their corresponding definitions:

Value Definition
Y The address is associated with a valid CMRA
N The address is not associated with a valid CMRA
Blank The address was not submitted for CMRA verification

Congressional District

Contains the federal congressional district for the submitted address.

County FIPS

Contains the 5-digit County FIPS (Federal Information Processing Standards) code for the submitted address. The County FIPS code is a combination of a 2-digit State FIPS code and the 3-digit county code designated by NIST (National Institute of Standards and Technology.

County Name

Contains the name of the County of the submitted address.

Default Flag

Indicates whether the address processed obtained an exact match to a record in the ZIP + 4 file–either to a highrise or a rural route default record. A positive value will also be present when a match is made to a base street record where high-rise exact records exist and no high-rise default record is present on the ZIP + 4 file.

Value Definition
Y The address is a default match to either a high-rise or rural route record
Blank The address is not a default match to a high-rise or rural route record

Deliverable

Indicates the deliverability status of the address. An address is considered “deliverable” if it is valid AND not vacant.

Value Definition Details
Y DeliverableThe address is deliverable.
Blank Not DeliverableThe address could not be verified as deliverable.

Delivery Line1

Contains the first delivery line (usually the street address) for the submitted address. This can include any of the following:

PrimaryNumber
StreetName
StreetPredirection
StreetPostdirection
StreetSuffix
SecondaryNumber
SecondaryDesignator
PmbDesignator
PmbNumber

Delivery Line2

Contains the second delivery line (if needed) for the submitted address. It is common for this field to remain empty, but this field will also frequently list a private mail box number.

Delivery Point

Includes the last two digits of the house/box number, or if an “H” record is matched, the secondary unit number representing the delivery point information to form the 11-digit delivery point bar code (DPBC).

Delivery Point Barcode

Contains the 12-digit PostNet barcode for the submitted address.

DeliveryPointCheckDigit

Same as CheckDigit.

DPV Code

Indicates the status of the Delivery Point Validation (if requested by User). This lets you know whether or not the USPS delivers mail to the associated address. The following is a list of all DPVCodes listed with their corresponding definitions:

Value Definition Details
Y ConfirmedThe entire address was DPV confirmed as a deliverable address.
N Not ConfirmedThe address could not be DPV confirmed as a deliverable address.
S Confirmed - By Dropping Secondary InfoThe address was DPV confirmed by dropping the secondary information (apartment, suite, etc.)
D Confirmed - Missing Secondary InfoThe address was DPV confirmed, but it is missing secondary information (apartment, suite, etc.)
Blank Not SubmittedThe address was not submitted for DPV confirmation. This is usually because the address does not have a ZIP code and +4 add-on code, or the address has already been determined to be Not Deliverable.

DPV Footnotes

Indicates why the address was given its DPV value. This field may also indicate the type of ZIP code that the address is associated with in the database (General Delivery, Military, PO Box, or Unique). The following is a list of all DPVFootnotes listed with their corresponding definitions:

Value Definition
AA ZIP+4 matched
A1 ZIP+4 did not match
BB Confirmed entire address
CC Confirmed address by dropping secondary (apartment, suite, etc.) information
F1 Matched to military address
G1 Matched to general delivery address
N1 Confirmed with missing secondary information
M1 Primary number missing
M3 Primary number invalid
P1 PO, RR, or HC Box number missing
P3 PO, RR, or HC Box number invalid
RR Confirmed address with private mail box (PMB) information
R1 Confirmed address without private mailbox (PMB) information
U1 Matched to a unique ZIP code

Duplicate

Indicates whether or not the address has been flagged as a duplicate of another address within the same list. The addresses are first standardized and then checked for duplicates. A duplicate is determined by Address/City/State/ZIP. It does not factor in recipient name or company.

Value Definition Details
Y DuplicateAddress is a duplicate of another in the current list.
Blank Not DuplicateAddress is NOT a duplicate of another in the current list.

EWS

Indicates whether or not the address was flagged by Early Warning System (EWS). A positive result indicates that the street of the address is not yet ready for mail delivery and that the address will soon be added to the master ZIP+4 file (in the coming weeks or months). This commonly occurs for new streets or streets undergoing a name change.

Value Definition Details
Y MatchThe address was flagged by EWS, preventing a ZIP+4 match.
Blank No MatchThe address was not flagged by EWS.

Firm Name

Contains the name of the company, building, apartment complex, shopping center, or other distinguishing address information as found in the USPS database for the input street address. This field will normally list firms or high-rise records, but may also contain literals such as “Postmaster” or “United States Postal Service.” If you mapped the company name to this column and the USPS database does not include any company-specific data for this address, the company name you provided will be included in the results.
If you didn’t include a company name and the USPS database does not include any company-specific data for this address, this field will contain the combined First and Last Name.

Flag Reason

Indicates the reason for the ProcessFlag.

Value Definition Details
10 Invalid Dual AddressInformation presented could not be processed in current format. Corrective action is needed. Be sure that the address line components are correct. For example, the input address line may contain more than one delivery address.
11 Invalid City/St/ZIPThe ZIP code in the submitted address could not be found because a valid city, state, nor valid 5-digit ZIP code was present. Corrective action is needed. SmartyStreets recommends that the customer check the accuracy of the submitted address.
12 Invalid StateThe state in the submitted address is invalid. Corrective action is needed. SmartyStreets recommends that the customer check the accuracy of the submitted address.
13 Invalid CityThe city in the submitted address is invalid. Corrective action is needed. SmartyStreets recommends that the customer check the accuracy of the submitted address.
21 Not FoundThe address, exactly as submitted, could not be found in the national ZIP + 4 file. SmartyStreets recommends that the customer check the accuracy of the submitted address. For example, the street address line may be abbreviated excessively and may not be fully recognizable.
22 Multiple ResponseMore than one ZIP + 4 Code was found to satisfy the address submitted. The submitted address did not contain sufficiently complete or correct data to determine a single ZIP + 4 Code. SmartyStreets recommends that the customer check the accuracy and completeness of the submitted address. Elements of the address may be missing.
31 Exact MatchSingle response based on input information. No corrective action is needed since an exact match was found in the ZIP + 4 file.
32 Default MatchA match was made to a default record in the national ZIP +4 file. A more specific match may be available if a secondary number (apartment, suite, etc.) exists.

Footnotes

Indicates whether or not any changes were made to the address. Includes what the specific changes were.

Value Definition Details
A# ZIP code correctedThe address was found to have a different 5-digit ZIP code than given in the submitted list. The correct ZIP code is shown in the ZIPCode field.
B# City / state spelling correctedThe spelling of the city name and/or state abbreviation in the submitted address was found to be different than the standard spellings. The standard spelling of the city name and state abbreviations are shown in the City and State fields.
C# Invalid city / state / ZIPThe ZIP code in the submitted address could not be found because a valid city, state, nor valid 5-digit ZIP code was present. SmartyStreets recommends that the customer check the accuracy of the submitted address.
D# No ZIP+4 assignedThis is a record listed by the United States Postal Service as a non-deliverable location. SmartyStreets recommends that the customer check the accuracy of the submitted address.
E# ZIP code assigned for multiple responseMultiple records were returned, but each shares the same 5-digit ZIP code.
F# Address Not FoundThe address, exactly as submitted, could not be found in the city, state, or ZIP code provided. SmartyStreets recommends that the customer check the accuracy of the submitted address.
G# Firm Data UsedInformation in the firm line was determined to be a part of the address. It was moved out of the firm line and incorporated into the address line.
H# Missing secondary numberZIP + 4 information indicates that this address is a building. The address as submitted does not contain a secondary (apartment, suite, etc.) number. SmartyStreets recommends that the customer check the accuracy of the submitted address and add the missing secondary number to ensure the correct Delivery Point Barcode (DPBC).
I# Insufficient / incorrect address dataMore than one ZIP + 4 Code was found to satisfy the address as submitted. The submitted address did not contain sufficiently compete or correct data to determine a single ZIP + 4 Code. SmartyStreets recommends that the customer check the accuracy and completeness of the submitted address. For example, a street may have a similar address at both the north and south sides of the street.
J# Dual addressThe input contained two addresses. For example: 123 MAIN ST PO BOX 99.
K# Multiple response due to cardinal ruleCASS rule does not allow a match when the cardinal point of a directional changes more than 90%. (i.e., 100 North Main will not match up with 100 South Main)
L# Address component changeAn address component (i.e., directional or suffix only) was added, changed, or deleted in order to achieve a match.
LL# Address flagged for LACSLinkThe input address matched to a record that was LACS-indicated, and that it was submitted to LACSLink for processing. This does not mean that the address was converted; it only means that the address was submitted to LACSLink because the input address had the LACS indicator set.
M# Street name changedThe spelling of the street name was changed in order to achieve a match.
N# Address standardizedThe delivery address was standardized. For example, if STREET was in the delivery address, SmartyStreets will return ST as its standard spelling.
P# Better address existsThe delivery address is matchable, but it is known by another (preferred) name. For example, in New York, NY, AVENUE OF THE AMERICAS is also known as 6TH AVE. An inquiry using a delivery address of 55 AVE OF THE AMERICAS would be flagged with Footnote P.
Q# Unique ZIP matchMatch to an address with a unique ZIP code.
R# No match due to EWSThe delivery address is matchable, but the Early Warning System file indicates that an exact match will be available soon.
S# Incorrect secondary addressThe secondary information (apartment, suite, etc.) does not match that on the national ZIP + 4 file. The secondary information, although present on the input address, was not valid in the range found on the national ZIP + 4 file.
T# Multiple response due to magnet street syndromeThe search resulted in a single response; however, the record matched was flagged as having magnet street syndrome and the input street name components (pre-directional, primary street name, post-directional, and suffix) did not exactly match those of the record. A “magnet street” is one having a primary street name that is also a suffix or directional word, having either a post-directional or a suffix (i.e., 2220 PARK MEMPHIS TN logically matches to a ZIP + 4 record 2200-2258 PARK AVE MEMPHIS TN 38114-6610), but the input address lacks the suffix “AVE” which is present on the ZIP + 4 record. The primary street name “PARK” is a suffix word. The record has either a suffix or a post-directional present. Therefore, in accordance with CASS requirements, a ZIP + 4 Code must not be returned. The multiple response return code is given since a “no match” would prevent the best candidate.
U# Unofficial post office nameThe city or post office name in the submitted address is not recognized by the United States Postal Service as an official last line name (preferred city name), and is not acceptable as an alternate name. The preferred city name is included in the City field.
V# Unverifiable city / stateThe city and state in the submitted address could not be verified as corresponding to the given 5-digit ZIP code. This comment does not necessarily denote an error; however, SmartyStreets recommends that the customer check the accuracy of city and state in the submitted address.
W# Invalid delivery addressThe input address record contains a delivery address other than a PO BOX, General Delivery, or Postmaster 5-digit ZIP code that is identified as a “small town default”. The USPS does not provide street delivery service for this ZIP code. The USPS requires use of a PO Box, General Delivery, or Postmaster for delivery within this ZIP code.
X# Unique ZIP code generatedDefault match inside a unique ZIP code.
Y# Military matchMatch made to a record with a military ZIP code.
Z# Match made using ZIPMOVE product dataThe ZIPMOVE product shows which ZIP + 4 records have moved from one ZIP code to another. If an input address matches to a ZIP + 4 record which the ZIPMOVE product indicates as having moved, the search is performed again in the new ZIP code.

Full ZIP Code

Contains the complete nine-digit ZIP code (if processed successfully) returned for the submitted address. The nine-digit ZIP code consists of the five-digit ZIP code plus the four-digit (+4) add-on code. If no add-on code exists, this field will contain only the five-digit ZIP code.

Input ID

Files that have an ID field that is successfully recognized during the import process will have this column in the simplified output files (simple-mailable, simple-duplicates, simple-rejected). The header name will be wrapped in brackets ('[]'). The input values will remain unchanged - we include this column to facilitate integrating the processed records with your database/spreadsheet.

Input Index

This is the order that the addresses were submitted to the API.

Input Names

Files that have name fields (first name, last name, or full name) that are successfully recognized during the import process will include these columns in the simplified output files (simple-mailable, simple-duplicates, simple-rejected). The field names will be wrapped in brackets ('[]'). The input values will remain unchanged by our system - we include these columns mainly to facilitate the generation of mailing labels.

LACS Indicator

Indicates whether the address has an entry in the Locatable Address Conversion Service

Value Definition Details
L MatchThere is a conversion address in the LACSLink database
Blank No MatchNo conversion address was found

LACSLink Code

Displays the reason for the Original LACSLink indication given.

Value Definition Details
A Match - Address ProvidedLACSLink record match, and a converted address is provided in the address data fields
00 No MatchNo match, and no converted address
09 Match - No New AddressLACSLink matched an input address to an old address, which is a 'highrise default' address, no new address is provided
14 Match - No ConversionFound LACSLink record, but couldn’t convert the data to deliverable address
92 Match - Dropped Secondary NumberLACSLink record matched after dropping the secondary number from input
Blank Not AttemptedNo LACSLink lookup attempted

LACSLink Ind

Indicates whether or not there is an address match with the LACSLink database.

Value Definition Details
Y LACS Record matchA new address could be furnished. The input record matched to a record in the master file
S LACS Record - Secondary number droppedThe record is a ZIP + 4 street level or highrise match. The input record matched to a master file record, but the input address had a secondary number and the master file record did not
N No MatchA new address could not be furnished. The input record COULD NOT be matched to a record in the master file
F False PositiveA false positive record was detected
Blank Not AttemptedNo LACSLink lookup attempted

Last Line Indicator

This combines the City, State, and ZIP code into a single field.

Latitude

This is the north/south component used for geographic positioning. Combining latitude and longitude enables you to determine the position of an address on a map. A negative number denotes a location below the equator. A positive number denotes a location above the equator.

The Precision field indicates the relative accuracy of the coordinates. We resolve latitude data out to 5 decimals (which equates to approximately 3ft² at the equator).

Longitude

This is the east/west component used for geographic positioning. Combining latitude and longitude enables you to determine the position of an address on a map. A negative number denotes a location west of Greenwich, England. A positive number denotes a location east of Greenwich, England.

The Precision field indicates the relative accuracy of the coordinates. We resolve latitude data out to 5 decimals (which equates to approximately 3ft² at the equator).

Plus4Code

Same as AddonCode.

PMB Designator

Same as PMBUnit.

PMB Number

Contains the private mail box (PMB) number returned for the submitted address. A PMB is usually a box that is assigned by a commercial mail receiving agency (CMRA).

PMB Unit

Contains the private mail box (PMB) unit designator returned for the submitted address. A PMB is usually a box that is assigned by a commercial mail receiving agency (CMRA).

Primary Number

The house, PO BOX, or building number.

Precision

The latitude/longitude coordinates that we return will always be accompanied by the Precision value. This indicates the degree of precision for a particular set of address coordinates. “State-level” is the least precise while “Structure-level” is the most precise.

Value Definition
Unknown The latitude/longitude coordinates are not known. Possibly because the address is invalid
None This indicates that latitude/longitude coordinates are not provided for this address. Military address such as APO and FPO do not provide latitude/longitude.
State Reserved for future use
SortationArea Reserved for future use
City Reserved for future use
Zip5 The latitude/longitude are accurate to the 5-digit ZIP Code level
Zip6 The latitude/longitude are accurate to the 6-digit ZIP Code level
Zip7 The latitude/longitude are accurate to the 7-digit ZIP Code level
Zip8 The latitude/longitude are accurate to the 8-digit ZIP Code level
Zip9 The latitude/longitude are accurate to the 9-digit ZIP Code level
Structure Reserved for future use

Process Flag

Indicates whether or not the submitted address was successfully verified.

Value Definition Details
P PassThis address was processed and the standardized address was returned.
F FailThis address was not processed, and the input address was returned. See the FlagReason field for more information on why the address was not processed.

RDI

Residential Delivery Indicator shows the residential/commercial status for each successfully validated address. This data is updated monthly.
NOTE: Use of the RDI data is subject to additional license terms which can be found on the Profile page in your account.

Value Definition
residentialThe address is designated as a residential address.
commercialThe address is designated as a commercial address.
unknownThe residential/commercial designation of this address is currently unknown

Record Type

Indicates the type of record that was matched. This field will only be populated when a DPV match is made.The following is a list of all RecordTypes listed with their corresponding definitions:

Value Definition Details
F FirmThe address is a Firm record, the finest level of match available for an address
G General DeliveryThe address is a General Delivery record
H HighriseThe address is a High-rise record, representing either a Building or an Apartment record
P PO BoxThe address is a Post Office Box record
R Rural RouteThe address is either a Rural Route or Highway Contract record, both of which may have associated box number ranges
S StreetThe address is a Street record, containing a valid primary number range
Blank No MatchA record type has not been returned because the address did not make a valid DPV match

Secondary Designator

Contains descriptive information about the location within a building or location (ie. Suite–STE, Apartment–APT, etc…)

Secondary Number

Contains the apartment or suite number, if any.

Sequence

Indicates the order of the addresses in your list when they were submitted to our service.

State

Contains the state abbreviation returned for the submitted address.

State Abbreviation

Same as State.

Street Name

Contains the preferred name of the street of the address.

Street Postdirection

Contains a value that provides directional information at the end of the street name (North–N, South-west–SW, etc…).

Street Predirection

Contains a value that provides directional information at the beginning of the street name (North–N, South-west–SW, etc…).

Street Suffix

Contains an abbreviated value that further describes the street name (ie. Street–ST, Avenue–AVE, etc…)

Urbanization

Contains the Urbanization name for the address. This field is used primarily for Puerto Rican addresses, and contains an area, sector or development within a geographic area. These are the most important parts of a Puerto Rican address, and should be included following the name when addressing mail for Puerto Rico.

Vacant

Indicates that a delivery point was active in the past, but is currently vacant (in most cases, unoccupied over 90 days), and not receiving delivery.

(For example, if the mail carrier is depositing mail in a receptacle and the receptacle is not being emptied, thus no more mail can be delivered, the mail carrier may retrieve all the mail in that receptacle and store it at the post office. A note would be left in the receptacle indicating this. After a certain amount of time being held at the post office, the mail would be handled as undeliverable and the address marked as “vacant”.)

Value Definition Details
Y VacantThe address is vacant
N Not VacantThe address is not vacant
Blank Not SubmittedThe address was not submitted for VACANT verification

ZIP Code

Contains the five-digit ZIP code (if processed successfully) returned for the submitted address.

field-definitions.txt · Last modified: 2012/04/02 19:19 by admin