search_by_attributes Flags
search_by_attributes
These are the control flags applicable to:
- C/C++:
Sz_searchByAttributes - C#:
SearchByAttributes - Java:
searchByAttributes - Python:
search_by_attributes - sz_command:
search_by_attributes
search_by_attributes uses all the get_entity*() flags
, plus SZ_INCLUDE_FEATURE_SCORES
, SZ_INCLUDE_MATCH_KEY_DETAILS
, 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
.
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_INCLUDE_FEATURE_SCORES
.
Click to expand response JSON Click to collapse
{
"RESOLVED_ENTITIES": [
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME",
"CANDIDATE_KEYS": {
"EMAIL_KEY": [
{
"FEAT_ID": 39,
"FEAT_DESC": "[email protected]"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
},
{
"FEAT_ID": 21,
"FEAT_DESC": "PP|SM0"
}
]
},
"FEATURE_SCORES": {
"EMAIL": [
{
"INBOUND_FEAT_ID": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 37,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1,
"ENTITY_NAME": "Robert Smith",
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 20,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 20
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 46
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 3,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 3
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 45,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 45
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 2,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 2
},
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 19
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 37,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 37
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 44,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 44
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 36
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 18
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"CANDIDATE_KEYS": {
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5,
"ENTITY_NAME": "Robert E Smith Sr",
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 57,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 57
}
]
},
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 1373,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 1373
}
]
}
],
"DOB": [
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 1372,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 1372
}
]
}
],
"DRLIC": [
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 58,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 58
}
]
}
],
"NAME": [
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 1371,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 1371
},
{
"FEAT_DESC": "Robbie Smith",
"LIB_FEAT_ID": 56
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 1
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"CANDIDATE_KEYS": {
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"EMAIL": [
{
"INBOUND_FEAT_ID": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 1395,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE": 0,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 0
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145,
"ENTITY_NAME": "Robert Smith",
"FEATURES": {
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 1395,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 1395
}
]
}
],
"NAME": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
}
],
"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_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_INCLUDE_FEATURE_SCORES
.
Click to expand response JSON Click to collapse
{
"RESOLVED_ENTITIES": [
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME",
"CANDIDATE_KEYS": {
"EMAIL_KEY": [
{
"FEAT_ID": 39,
"FEAT_DESC": "[email protected]"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
},
{
"FEAT_ID": 21,
"FEAT_DESC": "PP|SM0"
}
]
},
"FEATURE_SCORES": {
"EMAIL": [
{
"INBOUND_FEAT_ID": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 37,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1,
"ENTITY_NAME": "Robert Smith",
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 20,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 20
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 46
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 3,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 3
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 45,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 45
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 2,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 2
},
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 19
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 37,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 37
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 44,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 44
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 36
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 18
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 4
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"CANDIDATE_KEYS": {
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5,
"ENTITY_NAME": "Robert E Smith Sr",
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 57,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 E Main St Henderson NV 89132",
"LIB_FEAT_ID": 57
}
]
},
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 1373,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main St, Las Vegas",
"LIB_FEAT_ID": 1373
}
]
}
],
"DOB": [
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 1372,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "3/31/1954",
"LIB_FEAT_ID": 1372
}
]
}
],
"DRLIC": [
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 58,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "112233 NV",
"LIB_FEAT_ID": 58
}
]
}
],
"NAME": [
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 1371,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert E Smith Sr",
"LIB_FEAT_ID": 1371
},
{
"FEAT_DESC": "Robbie Smith",
"LIB_FEAT_ID": 56
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 1
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"CANDIDATE_KEYS": {
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"EMAIL": [
{
"INBOUND_FEAT_ID": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 1395,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE": 0,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 0
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145,
"ENTITY_NAME": "Robert Smith",
"FEATURES": {
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 1395,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 1395
}
]
}
],
"NAME": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 1
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 9
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
}
}
],
"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_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 Click to collapse
{
"RESOLVED_ENTITIES": [
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145
}
}
}
],
"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_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 Click to collapse
{
"RESOLVED_ENTITIES": [
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145
}
}
}
],
"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_SEARCH_INCLUDE_STATS
Include statistics from search results.
Click to expand response JSON Click to collapse
{
"RESOLVED_ENTITIES": [
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145
}
}
}
],
"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_FEATURE_SCORES
Include feature scores.
Click to expand response JSON Click to collapse
{
"RESOLVED_ENTITIES": [
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "RESOLVED",
"MATCH_KEY": "+NAME+EMAIL",
"ERRULE_CODE": "SF1_CNAME",
"CANDIDATE_KEYS": {
"EMAIL_KEY": [
{
"FEAT_ID": 39,
"FEAT_DESC": "[email protected]"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
},
{
"FEAT_ID": 21,
"FEAT_DESC": "PP|SM0"
}
]
},
"FEATURE_SCORES": {
"EMAIL": [
{
"INBOUND_FEAT_ID": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 37,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"CANDIDATE_KEYS": {
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
},
{
"MATCH_INFO": {
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"CANDIDATE_KEYS": {
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"EMAIL": [
{
"INBOUND_FEAT_ID": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 1395,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE": 0,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 0
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
]
}
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145
}
}
}
]
}
SZ_INCLUDE_MATCH_KEY_DETAILS
Include match key details in addition to the standard match key.
Click to expand response JSON Click to collapse
{
"RESOLVED_ENTITIES": [
{
"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": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GNR_ON": -1,
"GENERATION_MATCH": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"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": 37,
"INBOUND_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_ID": 37,
"CANDIDATE_FEAT_DESC": "[email protected]",
"SCORE_BUCKET": "SAME"
}
]
},
"ERRULE_CODE": "SF1_CNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
},
{
"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": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GNR_ON": -1,
"GENERATION_MATCH": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "CLOSE"
}
]
},
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
},
{
"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": {
"GNR_FN": 97,
"GNR_SN": -1,
"GNR_GN": -1,
"GNR_ON": -1,
"GENERATION_MATCH": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "BOB SMITH",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "CLOSE"
}
]
},
"ERRULE_CODE": "SNAME"
},
"ENTITY": {
"RESOLVED_ENTITY": {
"ENTITY_ID": 145
}
}
}
]
}
If you have any questions, contact Senzing Support. Support is 100% FREE!