search_by_attributes Flags
search_by_attributes
These are the control flags applicable to:
- Python:
search_by_attributes - Java:
searchByAttributes - sz_command:
searchByAttributes - C/C++:
Sz_searchByAttributes
search_by_attributes uses all of the flags available to <code>get_entity*</code>, plus SZ_SEARCH_INCLUDE_FEATURE_SCORES, SZ_SEARCH_INCLUDE_MATCH_KEY_DETAIL, and SZ_SEARCH_INCLUDE_STATS.
The default composite flag is SZ_SEARCH_BY_ATTRIBUTES_ALL.
The recommended composite flags are SZ_SEARCH_BY_ATTRIBUTES_ALL, SZ_SEARCH_BY_ATTRIBUTES_STRONG, SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL, and SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG.
The parameter values (from our truthset) used to generate the response messages are:
- data_as_json:
{"NAME_FULL":"BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"}
SZ_SEARCH_BY_ATTRIBUTES_ALL
SZ_SEARCH_BY_ATTRIBUTES_ALL returns all matching entities (resolved, possibly same, possibly related, and name-only matches).
SZ_SEARCH_BY_ATTRIBUTES_ALL is a composite flag of: SZ_SEARCH_INCLUDE_ALL_ENTITIES, SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, SZ_ENTITY_INCLUDE_ENTITY_NAME, SZ_ENTITY_INCLUDE_RECORD_SUMMARY, and SZ_SEARCH_INCLUDE_FEATURE_SCORES.
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"FEATURE_SCORES":
{
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 10,
"CANDIDATE_FEAT_DESC": "robert.smith@email.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 0,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 0
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2,
"ENTITY_NAME": "Robert Smith",
"FEATURES":
{
"EMAIL":
[
{
"FEAT_DESC": "robert.smith@email.com",
"LIB_FEAT_ID": 10,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "robert.smith@email.com",
"LIB_FEAT_ID": 10
}
]
}
],
"NAME":
[
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9
}
]
}
],
"RECORD_TYPE":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7
}
]
}
]
},
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"FEATURE_SCORES":
{
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100025,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 35,
"CANDIDATE_FEAT_DESC": "Robert E Smith Sr",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 90,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 90,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4,
"ENTITY_NAME": "Robert E Smith Sr",
"FEATURES":
{
"ADDRESS":
[
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 100026,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 100026
}
]
},
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 37,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 37
}
]
}
],
"DOB":
[
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 36,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 36
}
]
}
],
"DRLIC":
[
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 38,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 38
}
]
}
],
"NAME":
[
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 35,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 35
},
{
"FEAT_DESC": "Robbie Smith",
"LIB_FEAT_ID": 100025
}
]
}
],
"RECORD_TYPE":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7
}
]
}
]
},
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 1
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME",
"FEATURE_SCORES":
{
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100003,
"CANDIDATE_FEAT_DESC": "bsmith@work.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100001,
"CANDIDATE_FEAT_DESC": "Bob J Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 93,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 93,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001,
"ENTITY_NAME": "Robert Smith",
"FEATURES":
{
"ADDRESS":
[
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 100079,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 100079
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 100067
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 100043,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 100043
}
]
}
],
"DOB":
[
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 100066,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 100066
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 100002,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 100002
},
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 100078
}
]
}
],
"EMAIL":
[
{
"FEAT_DESC": "bsmith@work.com",
"LIB_FEAT_ID": 100003,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "bsmith@work.com",
"LIB_FEAT_ID": 100003
}
]
}
],
"NAME":
[
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 100065,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 100065
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 100001
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 100077
}
]
}
],
"PHONE":
[
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080
}
]
}
],
"RECORD_TYPE":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7
}
]
}
]
},
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
}
]
}
SZ_SEARCH_BY_ATTRIBUTES_STRONG
SZ_SEARCH_BY_ATTRIBUTES_STRONG returns resolved and possibly-same matches.
SZ_SEARCH_BY_ATTRIBUTES_STRONG is a composite flag of: SZ_SEARCH_INCLUDE_RESOLVED, SZ_SEARCH_INCLUDE_POSSIBLY_SAME, SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, SZ_ENTITY_INCLUDE_ENTITY_NAME, SZ_ENTITY_INCLUDE_RECORD_SUMMARY, and SZ_SEARCH_INCLUDE_FEATURE_SCORES.
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"FEATURE_SCORES":
{
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 10,
"CANDIDATE_FEAT_DESC": "robert.smith@email.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 0,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 0
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2,
"ENTITY_NAME": "Robert Smith",
"FEATURES":
{
"EMAIL":
[
{
"FEAT_DESC": "robert.smith@email.com",
"LIB_FEAT_ID": 10,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "robert.smith@email.com",
"LIB_FEAT_ID": 10
}
]
}
],
"NAME":
[
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9
}
]
}
],
"RECORD_TYPE":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7
}
]
}
]
},
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"FEATURE_SCORES":
{
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100025,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 35,
"CANDIDATE_FEAT_DESC": "Robert E Smith Sr",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 90,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 90,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4,
"ENTITY_NAME": "Robert E Smith Sr",
"FEATURES":
{
"ADDRESS":
[
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 100026,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 100026
}
]
},
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 37,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 37
}
]
}
],
"DOB":
[
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 36,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 36
}
]
}
],
"DRLIC":
[
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 38,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 38
}
]
}
],
"NAME":
[
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 35,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 35
},
{
"FEAT_DESC": "Robbie Smith",
"LIB_FEAT_ID": 100025
}
]
}
],
"RECORD_TYPE":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7
}
]
}
]
},
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 1
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME",
"FEATURE_SCORES":
{
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100003,
"CANDIDATE_FEAT_DESC": "bsmith@work.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100001,
"CANDIDATE_FEAT_DESC": "Bob J Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 93,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 93,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001,
"ENTITY_NAME": "Robert Smith",
"FEATURES":
{
"ADDRESS":
[
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 100079,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 100079
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 100067
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 100043,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 100043
}
]
}
],
"DOB":
[
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 100066,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 100066
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 100002,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 100002
},
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 100078
}
]
}
],
"EMAIL":
[
{
"FEAT_DESC": "bsmith@work.com",
"LIB_FEAT_ID": 100003,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "bsmith@work.com",
"LIB_FEAT_ID": 100003
}
]
}
],
"NAME":
[
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 100065,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 100065
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 9
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 100001
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 100077
}
]
}
],
"PHONE":
[
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 100080
}
]
}
],
"RECORD_TYPE":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7,
"FEAT_DESC_VALUES":
[
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 7
}
]
}
]
},
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
}
]
}
SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL
SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL returns all matching entities (resolved, possibly same, possibly related, and name-only matches) with minimal data.
SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL is a composite flag of: SZ_SEARCH_INCLUDE_ALL_ENTITIES.
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001
}
}
}
]
}
SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG
SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG returns resolved and possibly-same matches with minimal data
SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG is a composite flag of: SZ_SEARCH_INCLUDE_RESOLVED, SZ_SEARCH_INCLUDE_POSSIBLY_SAME.
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001
}
}
}
]
}
SZ_SEARCH_INCLUDE_FEATURE_SCORES
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"FEATURE_SCORES":
{
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 10,
"CANDIDATE_FEAT_DESC": "robert.smith@email.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 0,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 0
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"FEATURE_SCORES":
{
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100025,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 35,
"CANDIDATE_FEAT_DESC": "Robert E Smith Sr",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 90,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 90,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME",
"FEATURE_SCORES":
{
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100003,
"CANDIDATE_FEAT_DESC": "bsmith@work.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100001,
"CANDIDATE_FEAT_DESC": "Bob J Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 93,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 93,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001
}
}
}
]
}
SZ_SEARCH_INCLUDE_STATS
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001
}
}
}
],
"SEARCH_STATISTICS":
[
{
"CANDIDATE_KEYS":
{
"FEATURE_TYPES":
[
{
"FTYPE_CODE": "NAME_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "EMAIL_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
}
],
"SUMMARY":
{
"FOUND": 3,
"NOT_FOUND": 0,
"GENERIC": 0
}
}
}
]
}
SZ_INCLUDE_MATCH_KEY_DETAILS
Click to expand response JSON
{
"RESOLVED_ENTITIES":
[
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"MATCH_KEY_DETAILS":
{
"CONFIRMATIONS":
[
{
"TOKEN": "NAME",
"FTYPE_CODE": "NAME",
"SCORE_BEHAVIOR": "NAME",
"SOURCE": "/SAME_NAME",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "CLOSE"
}
]
},
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 2
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"MATCH_KEY_DETAILS":
{
"CONFIRMATIONS":
[
{
"TOKEN": "NAME",
"FTYPE_CODE": "NAME",
"SCORE_BEHAVIOR": "NAME",
"SOURCE": "/SAME_NAME",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100025,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "CLOSE"
}
]
},
"ERRULE_CODE": "SNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 4
}
}
},
{
"MATCH_INFO":
{
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"MATCH_KEY_DETAILS":
{
"CONFIRMATIONS":
[
{
"TOKEN": "NAME",
"FTYPE_CODE": "NAME",
"SCORE_BEHAVIOR": "NAME",
"SOURCE": "/SAME_NAME",
"SCORE": 97,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 97,
"GNR_GN": -1,
"GNR_ON": -1,
"GNR_SN": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "CLOSE"
},
{
"TOKEN": "EMAIL",
"FTYPE_CODE": "EMAIL",
"SCORE_BEHAVIOR": "F1",
"SOURCE": "EMAIL",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "bsmith@work.com",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100003,
"CANDIDATE_FEAT_DESC": "bsmith@work.com",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE_BUCKET": "SAME"
}
]
},
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY":
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001
}
}
}
]
}