This Purpose is designed to identify an address match. The address might be postal, residential, delivery, descriptive, formal or informal.

This Match purpose is typically used after a search by

Address_Part1

.

Field	Required?
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No

The only required field is

Address_Part1

. The fields

Address_Part2

,

Postal_Area

,

Telephone_Number

,

ID

,

Date

,

Attribute1

and

Attribute2

are available as optional input fields to further differentiate an address. For example if the name of a City and/or State is provided as

Address_Part2

, it will help differentiate between a common street address [100 Main Street] in different locations.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

This Purpose is designed to identify a contact within an organization at a specific location.

This Match purpose is typically used after a search by

Person_Name

. However, either

Organization_Name

or

Address_Part1

could be used as the search criteria.

For ultimate quality, a tiered search using two or all three of these fields could be used in the search. (A tiered search is for example, a

Person_Name

search followed by an

Address_Part1

search).

Field	Required?
Person_Name	Yes
Organization_Name	Yes
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No

The required fields are

Person_Name

,

Organization_Name

, and

Address_Part1

. This is designed to successfully match person X at company Y and address Z.

To further qualify a match, the fields

Address_Part2

,

Postal_Area

,

Telephone_Number

,

ID

,

Date

,

Attribute1

and

Attribute2

may be optionally provided.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

The

Corporate Entity

Purpose is designed to identify an Organization by its legal corporate name, including the legal endings such as

INC, LTD

, etc. It is designed for applications that need to honor the differences between such names as ABC TRADING INC and ABC TRADING LTD.

This Match purpose is typically used after a search by

Organization_Name

.

Field	Required?
Organization_Name	Yes
Address_Part1	No
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Attribute1	No
Attribute2	No

It is in essence the same purpose as Organization, except that tighter matching is performed and legal endings are not treated as noise.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

The

Division

Purpose is designed to identify an Organization at an Address. It is typically used after a search by

Organization_Name

or by

Address_Part1

, or both.

Field	Required?
Organization_Name	Yes
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Attribute1	No
Attribute2	No

It is in essence the same purpose as Organization, except that Address_Part1 is a required field. Thus, this Purpose is designed to match company X at an address of Y (or Z, etc, if multiple addresses are supplied).

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

The Family purpose is designed to identify matches where individuals with the same or similar family names share the same address or the same telephone number.

This purpose is typically used after a tiered search (multi-search) by

Address_Part1

and

Telephone_Number

.

Field	Required?
Person_Name	Yes
Address_Part1	Yes
Telephone_Number	Yes
Address_Part2	No
Postal_Area	No
Attribute1	No
Attribute2	No

Emphasis is placed on the Last Name, or "Major Word" of the

Person_Name

field, so this is one of the few cases where word order is important in the way the records are passed to SSA-NAME3 for matching.

However, a reasonable score will be generated provided that a match occurs between the major word in one name and any other word in the other name.

Required fields are

Person_Name

,

Address_Part1

and

Telephone_Number

. Optional qualifying fields are

Address_Part2

,

Postal_Area

,

Attribute1

, and

Attribute2

.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

This Purpose is provided for general non-specific use. It is designed in such a way that there are no required fields. All field types are available as optional input fields.

Field	Required?
Person_Name	No
Organization_Name	No
Address_Part1	No
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No

One way this Purpose could be used is as a non-exact match filter before applying some other Match Purpose. (For exact match filters, use the

Filter

Purpose). For example, before passing a record to the

Division

Purpose, use the

Fields

Purpose to eliminate any company with

ID

numbers which do not score above 80%. To do this, the application would first pass the ID numbers to SSA-NAME3 for matching using

PURPOSE=FIELDS

, and then decide based on the score returned whether to pass the full records for matching by the

Division

Purpose.

The

Filter

Purpose is provided so that the application can perform exact match filtering based on the setting of one or more flags in the records. One call to

ssan3_match

can use up to nine Filters (

Filter1-9

).

Field	Required?
Filter1-9	Yes

For example, say an index supported searching and matching across two types of names: Company names (identified by a Name-Type-Flag of "C"), and Person names (identified by a Name-Type-Flag of "P"). A search application may need to support searches across both name types, as well as within each name type. To support the "within each name type" search, the application can use the Filter Purpose to filter out exact matches based on the name type flag.

The fields

Filter1-9

can be any code or flag.

For non-exact filtering, use the

Fields

Purpose.

The Household purpose is designed to identify matches where individuals with the same or similar family names share the same address.

This purpose is typically used after a search by

Address_Part1

.

Field	Required?
Person_Name	Yes
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
Attribute1	No
Attribute2	No

Emphasis is placed on the Last Name, or "Major Word" of the

Person_Name

field, so this is one of the few cases where word order is important in the way the records are passed to SSA-NAME3 for matching.

However, a reasonable score will be generated provided that a match occurs between the major word in one name and any other word in the other name.

Required fields are

Person_Name

and

Address_Part1

. Optional qualifying fields are

Address_Part2

,

Postal_Area

,

Telephone_Number

,

Attribute1

, and

Attribute2

.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

This Purpose is designed to identify a specific individual by name and with either the same ID number or Date of Birth attributes.

It is typically used after a search by

Person_Name

.

Field	Required?
Person_Name	Yes
ID	At least one of these two
Date
Attribute1	No
Attribute2	No

The required fields are

Person_Name

, and one of either

ID

and

Date

.

The fields

Attribute1

and

Attribute2

may be optionally provided to further qualify the match.

The Organization Purpose is designed to match organizations primarily by name. It is targeted at online searches when a name only lookup is required and a human is available to make the choice. Matching in batch would typically require other attributes in addition to name to make match decisions.

Field	Required?
Organization_Name	Yes
Address_Part1	No
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No

The only required field is

Organization_Name

. The fields

Address_Part1

,

Address_Part2

,

Postal_Area

,

Telephone_Number

,

ID

,

Date

,

Attribute1

and

Attribute2

may are also provided as optional input fields to refine the ranking.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

This Purpose is designed to identify a Person by name. It is targeted at online searches when a name only lookup is required and a human is available to make the choice. Matching in batch would typically require other attributes in addition to name to make match decisions.

Field	Required?
Person_Name	Yes
Address_Part1	No
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No

The only required field is

Person_Name

. The optional fields available for this purpose are

Address_Part1

,

Address_Part2

,

Postal_Area

,

Telephone_Number

,

ID

,

Date

,

Attribute1

, and

Attribute2

.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

The Resident Purpose is designed to identify a person at an address.

This purpose is typically used after a search by either

Person_Name

or

Address_Part1

, or both in a multi-search.

Field	Required?
Person_Name	Yes
Address_Part1	Yes
Address_Part2	No
Postal_Area	No
Telephone_Number	No
ID	No
Date	No
Attribute1	No
Attribute2	No

The required fields are

Person_Name

and

Address_Part1

. The fields

Address_Part2

,

Postal_Area

,

Telephone_Number

,

ID

,

Date

,

Attribute1

and

Attribute2

are optional input fields to help qualify or rank a match if more information is available.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.

This Purpose is designed to loosely identify a contact within an organization - that is without regard to actual location.

It is typically used after a search by

Person_Name

, however, a second search by

Organization_Name

could be used to get better quality.

Field	Required?
Person_Name	Yes
Organization_name	Yes
ID	No
Attribute1	No
Attribute2	No

The fields required for this Purpose are

Person_Name

and

Organization_Name

. This is designed to successfully match a person X at company Y.

In addition to the required fields,

ID

,

Attribute1

and

Attribute2

may be optionally provided for matching to further qualify a contact.

The

Wide_Household

purpose is designed to identify matches where the same address is shared by individuals with the same family name or with the same telephone number.

This purpose is typically used after a search by

Address_Part1

.

Field	Required?
Address_Part1	Yes
Person_Name	Yes
Telephone_Number	Yes
Address_Part2	No
Postal_Area	No
Attribute1	No
Attribute2	No

Emphasis is placed on the Last Name, or "Major Word" of the

Person_Name

field, so this is one of the few cases where word order is important in the way the records are passed to SSA-NAME3 for matching.

However, a reasonable score will be generated provided that a match occurs between the major word in one name and any other word in the other name.

Required fields are

Person_Name

,

Address_Part1

and

Telephone_Number

. Optional qualifying fields are

Address_Part2

,

Postal_Area

,

Attribute1

and

Attribute2

.

To achieve a "best of" score between

Address_Part2

and

Postal_Area

, pass

Postal_Area

as a repeat value in the

Address_Part2

field. For example:

*Address_Part2*100 Main St*Address_Part2*06870***

In this case, the

Address_Part2

score used will be the higher of the two scored fields.