Use the Format tab to Select an output format of JSON, DELIMITED, FIXED, PARQUET or TABLE. If an output format is not selected, JSON will be used as the default format.
Available Output Formats
Copy
- A special operation used to transfer data to the Target output location without any modifications.
Delimited
- Type: Text
- Format: Delimited, tabular
- Schema: User defined
Fixed
- Type: Text
- Format: Fixed
- Schema: User defined
JSON (Default)
- Type: Text
- Format: Complex Data Object
- Schema: Default Structure below
Parquet
- Type: Binary
- Format: Complex Data Object
- Schema: Default structure below
Table
- Type: Table
- Format: Tabular
- Schema: User defined
Default Object Structure
Core
This structure is used for both JSON and Parquet. The
data property contains all user defined fields and derived properties.
Name
Available when a name field is parsed.
addressStandardization
This section is available when using the BettrData.io address standardization add-on service.
Root
Components
Field Name | Type | Definition |
urbanization | varchar(64) | The neighborhood, or city subdivision; used with Puerto Rican addresses |
primary_number | varchar(30) | The house, PO Box, or building number |
street_name | varchar(64) | The name of the street |
street_predirection | char(16) | Directional information before a street name (N, SW, etc.) |
street_postdirection | char(16) | Directional information after a street name (N, SW, etc.) |
street_suffix | char(16) | Abbreviated value describing the street (St, Ave, Blvd, etc.) |
secondary_number | varchar(32) | Apartment or suite number, if any |
secondary_designator | varchar(16) | Describes location within a complex/building (Ste, Apt, etc.) |
extra_secondary_number | varchar(32) | Descriptive information about the location of a building within a campus(e.g., E-5 in "5619 Loop 1604, Bldg E-5, Ste. 101 San Antonio TX") |
extra_secondary_designator | varchar(16) | Description of the location type within a campus(e.g., Bldg, Unit, Lot, etc.) |
pmb_designator | varchar(16) | The private mailbox unit designator, assigned by a CMRA |
pmb_number | varchar(16) | The private mailbox number, assigned by a CMRA |
city_name | varchar(64) | The USPS-preferred city name for this particular address, or an acceptable alternate if provided by the user |
default_city_name | varchar(64) | The default city name for this 5-digit ZIP Code |
state_abbreviation | char(2) | The two-letter state abbreviation |
zipcode | char(5) | The 5-digit ZIP Code |
plus4_code | varchar(4) | The 4-digit add-on code (more specific than 5-digit ZIP) |
delivery_point | char(2) | The last two digits of the house/box number, unless an "H" record is matched, in which case this is the secondary unit number representing the delivery point information to form the delivery point barcode (DPBC). |
delivery_point_check_digit | char(1) | Correction character, or check digit, for the 11-digit barcode |
Metadata
Field Name | Type | Definition |
record_type | char(1) | Indicates the type of record that was matched. Only given if a DPV match is made.
F — Firm; the finest level of match available for an address.(e.g., Julie Julia 11300 Center Ave Gilroy CA 95020-9257)
G — General Delivery; for mail to be held at local post offices.(e.g., General Delivery Provo UT 84601)
H — High-rise; address contains apartment or building sub-units.(e.g., 1600 Pennsylvania Ave SE Washington DC 20003-3228)
P — Post Office box(e.g., PO Box 4735 Tulsa OK 74159-0735)
R — Rural Route or Highway Contract; may have box number ranges.(e.g., RR 2 Box 4560 Anasco PR 00610-9393)S — Street; address contains a valid primary number range.(e.g., 16990 Monterey Rd Lake Elsinore CA 92530-7529)
[blank] — No record type because address did not make a valid DPV match |
zip_type | varchar(32) | Indicates the type of the ZIP Code for the address that was matched. Only given if a 5-digit match is made.
Unique — The ZIP Code consists of a single delivery point, pertaining to a US Postal Service customer (like a large business or government agency) that routes all of its own mail internally.
Military — The ZIP Code pertains to military units and diplomatic organizations, often in foreign locations.
POBox — The ZIP Code is a PO Box ZIP Code and is assigned to a collection of Post Office Boxes.
Standard — The ZIP Code does not pertain to any of the above categories. |
county_fips | char(5) | The 5-digit county FIPS (Federal Information Processing Standards) code. It is a combination of a 2-digit state FIPS code and a 3-digit county code assigned by the NIST (National Institute of Standards and Technology). |
county_name | varchar(64) | The name of the county in which the address is located |
ews_match | char(5) | Early warning system flag; a positive result indicates 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.
true — The address was flagged by EWS, preventing a ZIP+4 match.
[blank] — Address was not flagged by EWS. |
carrier_route | char(4) | The postal carrier route for the address. Consists of a one-letter prefix followed by a three-digit route designator.(e.g., C007, R123)
C — Carrier Route (commonly termed "City Route")
R — Rural Route
H — Highway Contract Route
B — Post Office Box Section
G — General Delivery UnitRoutes C770 through C779 pertain to PO Box Street Addresses. |
congressional_district | char(2) | The congressional district to which the address belongs. Output will be two digits from 01 - 53 or "AL." "AL" means that the entire state (or territory) is covered by a single congressional district. These include Alaska, Delaware, Montana, North Dakota, South Dakota, Vermont, Wyoming, Washington DC, Virgin Islands, and other territories. |
building_default_indicator | char(1) | Indicates whether the address is the "default" address for a building; for example, the main lobby
Y — Yes
N — No |
rdi | varchar(12) | Residential Delivery Indicator (residential or commercial)
Residential — The address is a residential address.
Commercial — The address is a commercial address.
[blank] — This happens when the address is invalid or we don't have enough information to ascertain RDI status. The Bulk Address Validation Tool translates a [blank] RDI value to "Unknown."Note: For some reason, known only to the US Postal Service, PO Boxes are always marked as "Residential." |
elot_sequence | varchar(4) | eLOT (Enhanced Line of Travel) 4-digit sequence number |
elot_sort | varchar(4) | eLOT (Enhanced Line of Travel) product was developed to give mailers the ability to sort their mailings by line of travel sequence.
A — Ascending
D — Descending
[blank] — Address not submitted for eLOT |
latitude | decimal(12,9) | The horizontal component used for geographic positioning. It is the angle between 0° (the equator) and ±90° (north or south) at the poles. It is the first value in an ordered pair of (latitude, longitude). A negative number denotes a location below the equator; a positive number is above the equator. Combining lat/long values enables you to pinpoint addresses on a map. |
longitude | decimal(12,9) | The vertical component used for geographic positioning. It is the angle between 0° (the Prime Meridian) and ±180° (westward or eastward). It is the second number in an ordered pair of (latitude, longitude). A negative number indicates a location west of Greenwich, England; a positive number east. Combining lat/long values enables you to pinpoint addresses on a map. |
coordinate_license | int | The license ID for the geographic coordinate returned. See the licensing table below for more details. |
precision | varchar(18) | Indicates the precision of the latitude and longitude values.
Unknown — Coordinates not known. Reasons could include: address is invalid, military address (APO or FPO), lat/lon coordinates not available.
Zip5 — Accurate to a 5-digit ZIP Code level (least precise)
Zip6 — Accurate to a 6-digit ZIP Code level
Zip7 — Accurate to a 7-digit ZIP Code level
Zip8 — Accurate to an 8-digit ZIP Code level
Zip9 — Accurate to a 9-digit ZIP Code level (most precise with the basic subscription)
Parcel — Accurate to the centroid of a property parcel. Requires the US Rooftop Geocoding subscription.
Rooftop — Accurate to the rooftop of a structure for this address. Requires the US Rooftop Geocoding subscription.Note: Concerning addresses for which the ZIP9 precision is not available, the ZIP# precision is interpolated based on neighboring addresses. Thus, ZIP7 is an average of all the lat/long coordinates of nearby ZIP Codes that share those first 7 digits. |
time_zone | varchar(48) | Indicates the common name of the time zone associated with the address.
Valid Responses: Alaska, Atlantic, Central, Eastern, Hawaii, Mountain, None, Pacific, Samoa, UTC+9, UTC+10, UTC+11, UTC+12 |
utc_offset | decimal(4,2) | Indicates the number of hours the time zone is offset from Universal Time Coordinated (UTC), the international time standard, also known as Greenwich Meridian Time (GMT).
Valid Responses-11, -10, -9, -8, -7, -6, -5, -4, 0, 9, 10, 11, 12 |
dst | char(5) | Indicates if the time zone "obeys," or, in other words, adjusts their clocks forward and back with the seasons. This information is particularly useful to determine time in other time zones with areas that may or may not use daylight saving time - for example, Arizona, Hawaii, and, of all places, Indiana.true — Time zone observes daylight saving time.If dst is absent from the response, then time zone does not observe daylight saving time. |
Analysis
Field Name | Type | Definition |
dpv_match_code | varchar(1) | Status of the Delivery Point Validation (DPV). This indicates whether or not the address is present in the USPS data.
Y — Confirmed; entire address is present in the USPS data. (To be certain the address is actually deliverable, verify that the dpv_vacant field has a value of N. You may also want to verify that the dpv_no_stat field has a value of N. However, the USPS is often several months behind in updating this data point, so only rely on the dpv_no_stat data if you are fully aware of its weaknesses and limitations.)(e.g., 1600 Amphitheatre Pkwy Mountain View, CA)
N — Not confirmed; address is not present in the USPS data.
S — Confirmed by ignoring secondary info; the main address is present in the USPS data, but the submitted secondary information (apartment, suite, etc.) was not recognized.(e.g., 62 Ea Darden Dr Apt 298 Anniston, AL)
D — Confirmed but missing secondary info; the main address is present in the USPS data, but it is missing secondary information (apartment, suite, etc.).(e.g., 122 Mast Rd Lee, NH)
[blank or null] — The address is not present in the USPS database. |
dpv_footnotes | varchar(32) | Information related to the delivery point validation of this address. All these footnotes have a length of 2 characters, and there may be up to 14 footnotes.
AA — Street name, city, state, and ZIP are all valid.(e.g., 2335 S State St Ste 300 Provo UT)
A1 — Address is invalid.(e.g., 3214 N University Ave New York NY)
BB — Entire address is valid.(e.g., 2335 S State St Ste 300 Provo UT)
CC — The submitted secondary information (apartment, suite, etc.) was not recognized.(e.g., 2335 S State St Ste 500 Provo UT)
F1 — Military or diplomatic address(e.g., Unit 2050 Box 4190 APO AP 96278)
G1 — General delivery address(e.g., General Delivery Provo UT 84601)
M1 — Primary number (e.g., house number) is missing.(e.g., N University Ave Provo UT)
M3 — Primary number (e.g., house number) is invalid.(e.g., 16 N University Ave Provo UT)
N1 — Address is missing secondary information (apartment, suite, etc.).(e.g., 2335 S State St Provo UT)
PB — PO Box street style address.(e.g., 555 S B B King Blvd Unit 1 Memphis TN 38103)
P1 — PO, RR, or HC box number is missing.(e.g., Dept 126 Denver CO 802910126)
P3 — PO, RR, or HC box number is invalid.(e.g., PO BOX 60780 FAIRBANKS AK 99706)
RR — Confirmed address with private mailbox (PMB) info.(e.g., 3214 N University Ave #409 Provo UT)
R1 — Confirmed address without private mailbox (PMB) info.(e.g., 3214 N University Ave Provo UT)
R7 — Confirmed as a valid address that doesn't currently receive US Postal Service street delivery.(e.g., 6D Cruz Bay St John VI 00830)
U1 — Address has a "unique" ZIP Code.(e.g., 100 North Happy Street 12345)Here are some common combinations:
• AABB - ZIP, state, city, street name, and primary number match.
• AAM1 - ZIP, state, city, and street name match, but the primary number is missing.
• AAM3 - ZIP, state, city, and street name match, but the primary number is invalid.
• AAN1 - ZIP, state, city, street name, and primary number match, but there is secondary information such as apartment or suite that would be helpful.
• AABBR1 - ZIP, state, city, street name, and primary number match. Address confirmed without private mailbox (PMB) info. |
dpv_cmra | varchar(1) | Indicates whether the address is associated with a Commercial Mail Receiving Agency (CMRA), also known as a private mailbox (PMB) operator. A CMRA is a business through which USPS mail may be sent or received, for example the UPS Store and Mailboxes Etc.
Y — Address is associated with a valid CMRA.
N — Address is not associated with a valid CMRA.
[blank] — Address was not submitted for CMRA verification. |
dpv_vacant | varchar(1) | Indicates that a delivery point was active in the past but is currently vacant (in most cases, unoccupied over 90 days) and is not receiving deliveries. This status is often obtained when mail receptacles aren't being emptied and are filling up, so mail is held at the post office for a certain number of days before the delivery point is marked vacant.
Y — Address is vacant.
N — Address is not vacant.[blank] — Address was not submitted for vacancy verification. |
dpv_no_stat | varchar(1) | Indicates that a delivery point is listed as "no-stat" by the USPS. Technically, that means the USPS is temporarily declaring the address undeliverable. In practice, however, the USPS is often several months behind in removing addresses from the "no-stat" list, so only rely on this data point if you are fully aware of its weaknesses and limitations.
Y — USPS lists the address as "no-stat."
N — USPS does not list the address as "no-stat."
[blank] — Address was not submitted for "no-stat" verification. |
active | varchar(1) | The API still returns this field, but in practical terms, it is deprecated. This field will contain a value of Y for every address submitted. |
footnotes | varchar(12) | Indicates which changes were made to the input address. Footnotes are delimited by a # character. See the footnotes table below for details. |
lacslink_code | varchar(2) | The reason for the LACSLink indication that was given (below)
A — Match: Address provided. LACSLink record match was found, and a converted address was provided.
00 — No Match. No converted address. No soup for you!
09 — Match: No new address. LACSLink matched an input address to an old address which is a "high-rise default" address; no new address was provided.
14 — Match: No conversion. Found a LACSLink record, but couldn't convert the data to a deliverable address.
92 — Match: Dropped secondary number. LACSLink record was matched after dropping the secondary number from input.
[blank] — No LACSLink lookup attempted. |
lacslink_indicator | varchar(1) | Indicates whether there is an address match in the LACSLink database.
Y — LACS record match; a new address could be furnished because the input record matched a record in the master file.
S — LACS record - secondary number dropped; the record is a ZIP+4 street level or high-rise match. The input record matched a master file record, but the input address had a secondary number and the master file record did not.
N — No match; a new address could not be furnished; the input record could not be matched to a record in the master file.
F — False positive; a false positive record was detected.
[blank] — No LACSLink lookup attempted. |
suitelink_match | varchar(5) | Indicates a match (or not) to the USPS SuiteLink data. SuiteLink attempts to provide secondary information such as "suite" or "apartment" whenever there is a match based on address and company name.
true — There was a SuiteLink match and the result is provided.
false — There was no SuiteLink match. |
enhanced_match | varchar(64) | When an address is submitted with the match parameter set to "enhanced," this field will contain additional information about the result. Multiple values may be present, separated by commas. Additional values will be added from time to time. The current possible values are:
[blank] — Enhanced matching was not performed because it was unnecessary to obtain a match.
none — Enhanced matching was performed but no address match was found.
non-postal-match — Enhanced matching was performed and a match was found within additional, non-postal address data.
postal-match — Enhanced matching was performed and a match was found within postal address data.
missing-secondary — The address should have a secondary (e.g., apartment), but none was found in the input.
unknown-secondary — The provided secondary information did not match a known secondary within the address data.
ignored-input — The provided input contained information that was not used for a match. |
NCOA
Field Name | Type | Definition |
moveDate | varchar(6) | The date the move was filed with the USPS, in YYYYMM format. |
moveType | varchar(1) | Contains the type of match:
I - Individual Match,
F - Family Match,
B - Business Name Match |
nxi | varchar(2) | Status Code Returned During NCOA Link Processing
A - Matched record and a new address has been provided (NCOAlink 18Month Service code only)
00 - No Match (NCOAlink 18 month Service code only)
01 - Found COA: Foreign Move - The input record matched to a business, individual or family type master file record but the new address was outside USPS delivery area.
02 - Found COA: Moved Left No Address (MLNA) - The input record matched to a business, individual or family type master file record and the new address was not provided to USPS.
03 - Found COA: Box Closed No Order (BCNO) - The Input record matched to a business, individual or family type master file record which contains an old address of PO BOX that has been closed without a forwarding address provided.
04 - Cannot match COA: Street Address with Secondary - In the STANDARD mode utilizing Family matching logic the input record matched to a family record type on the master file with an old address that contained secondary information which obtained a ZIP+4 street level match. The input record does not contain secondary information. This address match situation requires individual name matching logic to obtain a match and individual names do not match.
05 - Found COA: New 11-digit DPBC is Ambiguous - The input record matched to a business, individual or family type master file record. The new address on the master file record could not be converted to a deliverable address because the DPBC represents more than one delivery point.
06 - Cannot Match COA: Conflicting Directions: Middle Name Related -There is more than one COA (individual or family type) record for the match algorithm and the middle names or initials on the COAs are different. Therefore, a single match result could not be determined.
07 - Cannot Match COA: Conflicting Directions: Gender Related -There is more than one COA (individual or family type) record for the match algorithm and the genders of the names on the COAs are different. Therefore, a single match result could not be determined.
08 - Cannot Match COA: Other Conflicting Instructions - The input record matched to two master file (business, individual or family type) records. The two records in the master file were compared and due to differences in the new addresses, a match could not be made.
09 - Cannot Match COA: High-rise Default - The input record matched to a family record on the master file from a High- rise address ZIP+4 coded to the building default. This address match situation requires individual name matching logic to obtain a match and individual names do not match.
10 - Cannot Match COA: Rural Default - The input record matched to a family record on the master file from a Rural Route or Highway Contract Route address ZIP+4 coded to the route default. This address situation requires individual name matching logic to obtain a match and individual names do not match.
11 - Cannot Match COA: Individual Match: Insufficient COA Name for Match - There is a master file (individual or family type) record with the same surname and address but there is insufficient name information on the master file record to produce a match using individual matching logic.
12 - Cannot Match COA: Middle Name Test Failed - The input record matched to an individual or family record on the master file with the same address and surname. However, a match cannot be made because the input name contains a conflict with the middle name or initials on the master file record.
13 - Cannot Match COA: Gender Test Failed - The input record matched to a master file (individual or family type) record. A match cannot be made because the gender of the name on the input record conflicts with the gender of the name on the master file record.
14 - Found COA: New Address Would Not Convert at Run Time - The input record matched to a master file (business, individual or family type) record. The new address could not be converted to a deliverable address.
15 - Cannot Match COA: Individual Name Insufficient - There is a master file record with the same address and surname. A match cannot be made because the input record does not contain a first name or contains initials only.
16 - Cannot Match COA: Secondary Number Discrepancy - The input record matched to a street level individual or family type record. However, a match is prohibited based on I of the following reasons: 1) There is conflicting secondary information on the input and master file record; 2) the input record contained secondary information and matched to a family record that does not contain secondary information. In item 2, this address match situation requires individual name matching logic to obtain a COA match and individual names do not match.
17 - Cannot Match COA: Other Insufficient Name - The input record matched to an individual or family master file record. The input name is different or not sufficient enough to produce a match.
18 - Cannot Match COA: General Delivery - The input record matched to a family record on the master file from a General Delivery address. This address situation requires individual name matching logic to obtain a match and individual names do not match.
19 - Found COA: New Address not ZIP+4 coded - There is a change of address on file but the new address cannot be ZIP+4 coded and therefore there is no 11 -digit DPBC to store or return.
20 - Cannot Match COA: Conflicting Directions after re-chaining - Multiple master file records were potential matches for the input record. The master file records contained different new addresses and a single match result could not be determined.
66 - Daily Delete - The input record matched to a business, individual or family type master file record with an old address that is present in the daily delete file. The presence of an address in the daily delete file means that a COA with this address is pending deletion from the master file and that no mail may be forwarded from this address.
91 - Found COA : Secondary Number dropped from COA
The input record matched to a master file record. The master file record had a secondary number and the input address did not. A new address was provided.
92 - Found COA : Secondary Number Dropped from input address
The input record matched to a master file record, but the input address had a secondary number and the master file record did not. The record is a ZIP + 4® street level match. A new address was provided. |
status_ | varchar(1) | V - Valid
N - Non-deliverable
M - Multi-Matched |
errono_ | Error Summary List:
1.1 State not found
2.1 City not found
3.1 Street not found
4.1 Address not found
5.1 Incomputable +4 range
5.2 +4 unavailable
6.1 Multiple streets match
6.2 Multiple addresses match
6.3 Cardinal Rule multiple match
7.1 Time ran out
7.2 Output too long
Warning Summary List:
8.1 Company phonetic match used
8.2 First company match used
9.1 State determined from city
9.2 State determined from ZIP
10.1 City phonetic match used
10.2 City determined from ZIP
10.3 Acceptable city name used
11.0 Address component Chg/Del/Add
11.1 Street phonetic match used
11.2 Pre-direction dropped
11.3 Pre-direction added
11.4 Suffix dropped
11.5 Suffix added
11.6 Post direction dropped
11.7 Post direction added
11.8 Pre-direction standardized
11.9 Street standardized
11.10 Suffix standardized
11.11 Post direction standardized
11.12 Street missing
11.13 Alternate address used
11.14 Address Standardized
11.15 Dual address-Used PO Box
11.16 Dual address-Used Non-PO Box
11.17 Street Alias match-Better delivery address exists
12.1 Unit standardized
12.2 Unit missing
12.3 Unit not found
12.4 Unit unverified
12.5 Rural box not found
13.1 Leftovers found
14.1 No ZIP Code Available
14.2 Incorrect ZIP Code was changed to correct ZIP
14.3 +4 changed
14.4 Route changed
14.5 +4 added
14.6 Route added
14.7 ZIP assigned for Multi-matched address
14.8 Unique ZIP match
14.9 Small town default match
15.0 ZIP Code Changed
15.1 Highrise Default
15.2 Highrise Exact
15.3 Rural Route Default
15.4 Rural Route Exact
15.5 Early Warning System match.
15.6 LACSLink Conversion Match
15.7 SuiteLink Match - Suite Returned
15.8 SuiteLink Match - No Suite Returned
Warning A1 to A10:
This indicates which Address block was used to code the record |
Footnotes
This table describes possible values in the footnotes field from the analysis object.
(Example addresses may be changed at any time due to the nature of the data.)