Postal Matcher Attributes for the United States (US) - trillium_discovery - trillium_quality - Latest

Trillium Input/Output Attributes Reference Guide

Product type
Software
Portfolio
Verify
Product family
Trillium
Product
Trillium > Trillium Quality
Trillium > Trillium Discovery
Version
Latest
Language
English
Product name
Trillium Quality and Discovery
Title
Trillium Input/Output Attributes Reference Guide
Copyright
2024
First publish date
2008
Last updated
2024-10-18
Published on
2024-10-18T15:22:28.756348

The table given below lists the Postal Matcher input and output attributes for the United States (US).

Table 1. US Postal Matcher Attributes

Attribute Name

Length

Description

us_gin_address_type

1

Input address type. Values are:

1—street

2—rr/hc

3—pobox

4—error

5—Bad Street Pattern

F—Foreign

us_gin_bldg_firm_name

40

Input name.

us_gin_box_number

10

PO box number on dual address records.

us_gin_city_change_flag

1

City change flag.

us_gin_dual_addr_flag

1

Dual address flag. Values are:

G—general delivery

P—po box

R—rural route

Blank

us_gin_filler_01

28

Reserved for future use.

us_gin_house_number

10

Input house number.

us_gin_postal_city_name

30

Postal city name.

us_gin_postal_city_number

6

Postal city number.

us_gin_postal_code

9

Input postal code.

us_gin_postal_code_original

9

Original postal code.

us_gin_postal_index_01- 06

6

Postal finance number.

us_gin_route_number

10

Rural route number.

us_gin_secondary_number

10

Input secondary number.

us_gin_secondary_type

4

Input secondary type.

us_gin_state_change_flag

1

State change flag.

us_gin_state_name

2

State abbreviation.

us_gin_street_name

40

Input street name.

us_gin_street_post_direction

2

Input post-direction.

us_gin_street_pre_direction

2

Input pre-direction.

us_gin_street_suffix

4

Input street suffix (type).

us_gin_tertiary_number

10

Tertiary number.

us_gin_tertiary_type

4

Tertiary type.

us_gin_urban_city_name

30

Urban city name.

us_gout_alias_street_name

40

Alias street name.

us_gout_alias_street_post_direction

2

Alias street post direction.

us_gout_alias_street_pre_direction

2

Alias street pre-direction.

us_gout_alias_street_suffix

4

Alias street suffix.

us_gout_alias_type

1

Alias type. Values are:

C = Street Name Change

A = Alias Street Name

O = Optional Street Name

us_gout_building_ind

1

Current number of apartments.

A < 5

B = 6 - 10

C = 11 - 25

D = 26 - 50

E = 51 - 100

F = 101 -200

G = 201 - 350

H > 350

us_gout_carrier_route

4

Carrier route ID.

Note: A return of a carrier route assignment of “777” in the us_gout_carrier_route attribute indicates the input address matched to a PBSA delivery location in the US Postal zip4 table.

us_gout_city_area_name_changed

1

This flag is set to Y if the city name changed from the input.

us_gout_completion_code

1

Return code.

  • 0 = Incomplete Address. Not matched to GAV table. Check the Match Level for more information.
  • 1 = Matched Address.

us_gout_congressional_district

2

This is a standard value identifying a geographic area within the US served by a member of the US House of Representatives or Senate. If there is only one member of Congress within a state, the code is "AL" to indicate "At Large."

us_gout_county_number

3

Numeric code to identify the county.

us_gout_delivery_address

50

Output delivery address. This is rebuilt from the best available matched or parsed address components.

us_gout_delivery_address_abrev

50

Delivery address abbreviation value, if one exists, otherwise the delivery address is stored.

us_gout_delivery_address_2

50

Additional address information.

us_gout_delivery_point

2

Output delivery point.

Note: The Delivery Point Barcode (DPBC) consists of the us_gout_postal_code, the us_gout_ delivery_point, and the us_gout_delivery_point_cd attributes.

us_gout_delivery_point_cd

1

Output delivery point check digit.

Note: The Delivery Point Barcode (DPBC) consists of the us_gout_postal_code, the us_gout_ delivery_point, and the us_gout_delivery_point_cd attributes.

us_gout_house_number

10

Output house number.

us_gout_lacs_status_ind

1

LACS indicator from the Zip4 file.

us_gout_match_level

1

Numeric code to identify the level at which the address matched, or failed to match, the GAV tables.

Values are:

0=exact match to table

1=city/province failure

2=street name failure

3=house number range failure

4=street component failure

5=multiple possible matches to table

6=match to GAV table but did not DPV confirm (CASS mode only).

us_gout_postal_city_name

30

Postal city name.

us_gout_postal_city_name_abrev

30

City name abbreviation value, if one exists, otherwise the city name is stored.

us_gout_postal_city_name_preferred

30

Preferred city name for the record's zip code.

Note: Some zip codes are used for more than one city. When there is more than one city for a zip code, the U.S Postal Service designates one as the preferred city; other cities are referred to as alternate cities.

us_gout_postal_code

9

Output postal code.

Note: The Delivery Point Barcode (DPBC) consists of the us_gout_postal_code, the us_gout_ delivery_point, and the us_gout_delivery_point_cd attributes.

us_gout_postal_code_changed

1

This flag is set to Y if the postal code changed from the input.

us_gout_record_type

2

Linked record type.

  • The first character represents the record type:
    • F = Firm
    • G = General Delivery
    • H = Highrise
    • P = PO Box
    • R = Rural Route
    • S = Street
  • The second character represents the match type:
    • Blank = Standard Match
    • D = Default Match
    • U = Unique Match
    • B = Both unique and default

us_gout_secondary_number

10

Secondary number.

us_gout_secondary_type

4

Secondary type.

us_gout_state_name

2

State abbreviation.

us_gout_street_components_changed

1

This flag is set to Y if the street components changed from the input.

us_gout_street_name

40

Street name.

us_gout_street_name_changed

1

This flag is set to Y if the street name changed from the input.

us_gout_street_post_direction

2

Street post direction.

us_gout_street_pre_direction

2

Street pre-direction.

us_gout_street_suffix

4

Street suffix.

us_gout_tertiary_number

10

Tertiary number.

us_gout_tertiary_type

4

Tertiary type.

us_gout_urban_city_name

30

Stores the urbanization name.