why_search Flags
why_search
These are the control flags applicable to:
- C/C++:
Sz_whySearch - C#:
WhySearch - Java:
whySearch - Python:
why_search - sz_command:
why_search
why_search supports all the get_entity*() flags
, plus search-specific flags for controlling the inclusion of request details, statistics, feature scores, and match key details.
NOTE: Unlike search_by_attributes, why_search does NOT support the search hit type flags (SZ_SEARCH_INCLUDE_RESOLVED
, SZ_SEARCH_INCLUDE_POSSIBLY_SAME
, SZ_SEARCH_INCLUDE_POSSIBLY_RELATED
, SZ_SEARCH_INCLUDE_NAME_ONLY
).
The default composite flag is SZ_WHY_SEARCH_DEFAULT_FLAGS
, the equivalent of SZ_INCLUDE_FEATURE_SCORES
| SZ_SEARCH_INCLUDE_REQUEST_DETAILS
| SZ_SEARCH_INCLUDE_STATS
.
SZ_WHY_SEARCH_DEFAULT_FLAGS
SZ_WHY_SEARCH_DEFAULT_FLAGS is a composite of: SZ_INCLUDE_FEATURE_SCORES
, SZ_SEARCH_INCLUDE_REQUEST_DETAILS
, and SZ_SEARCH_INCLUDE_STATS
.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+ADDRESS+EMAIL",
"WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"MATCH_LEVEL_CODE": "RESOLVED",
"CANDIDATE_KEYS": {
"ADDR_KEY": [
{
"FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS"
},
{
"FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132"
}
],
"DOB": [
{
"FEAT_ID": 2,
"FEAT_DESC": "12/11/1978"
}
],
"EMAIL_KEY": [
{
"FEAT_ID": 39,
"FEAT_DESC": "[email protected]"
}
],
"NAMEADDR_KEY": [
{
"FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132"
},
{
"FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS"
}
],
"NAMEDATE_KEY": [
{
"FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132"
},
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": -3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_ID": 3,
"CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 2,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FMES"
}
],
"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": "Robert Smith",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"GNR_FN": 100,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "NAME"
}
]
},
"DISCLOSED_RELATIONS": {}
}
}
],
"SEARCH_REQUEST": {
"JSON_DATA": "{\"NAME_FULL\": \"Robert Smith\", \"DATE_OF_BIRTH\": \"12/11/1978\", \"ADDR_FULL\": \"123 Main Street, Las Vegas NV 89132\", \"EMAIL_ADDRESS\": \"[email protected]\"}",
"SEARCH_PROFILE": "",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": -2,
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"NAME_FULL": "Robert Smith"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 0,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"DOB": [
{
"LIB_FEAT_ID": 2,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
},
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": -3,
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_FULL": "123 Main Street, Las Vegas NV 89132"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 0,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 37,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 3,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"ADDR_KEY": [
{
"LIB_FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"EMAIL_KEY": [
{
"LIB_FEAT_ID": 39,
"FEAT_DESC": "[email protected]",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEADDR_KEY": [
{
"LIB_FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEREGION_KEY": [
{
"LIB_FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
]
}
},
"SEARCH_STATISTICS": [
{
"CANDIDATE_KEYS": {
"FEATURE_TYPES": [
{
"FTYPE_CODE": "DOB",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAME_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "ADDR_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "EMAIL_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEADDR_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEDATE_KEY",
"FOUND": 3,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEREGION_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
}
],
"SUMMARY": {
"FOUND": 12,
"NOT_FOUND": 0,
"GENERIC": 0
}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_INCLUDE_FEATURE_SCORES
Adding SZ_INCLUDE_FEATURE_SCORES includes a FEATURE_SCORES object in the MATCH_INFO showing how individual features were compared and scored.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+ADDRESS+EMAIL",
"WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"MATCH_LEVEL_CODE": "RESOLVED",
"CANDIDATE_KEYS": {
"ADDR_KEY": [
{
"FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS"
},
{
"FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132"
}
],
"DOB": [
{
"FEAT_ID": 2,
"FEAT_DESC": "12/11/1978"
}
],
"EMAIL_KEY": [
{
"FEAT_ID": 39,
"FEAT_DESC": "[email protected]"
}
],
"NAMEADDR_KEY": [
{
"FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132"
},
{
"FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS"
}
],
"NAMEDATE_KEY": [
{
"FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132"
},
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": -3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_ID": 3,
"CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 2,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FMES"
}
],
"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": "Robert Smith",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"GNR_FN": 100,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "NAME"
}
]
},
"DISCLOSED_RELATIONS": {}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_SEARCH_INCLUDE_STATS
Adding SZ_SEARCH_INCLUDE_STATS includes a SEARCH_STATISTICS array showing candidate key statistics for the search.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+ADDRESS+EMAIL",
"WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"MATCH_LEVEL_CODE": "RESOLVED"
}
}
],
"SEARCH_STATISTICS": [
{
"CANDIDATE_KEYS": {
"FEATURE_TYPES": [
{
"FTYPE_CODE": "DOB",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAME_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "ADDR_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "EMAIL_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEADDR_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEDATE_KEY",
"FOUND": 3,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEREGION_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
}
],
"SUMMARY": {
"FOUND": 12,
"NOT_FOUND": 0,
"GENERIC": 0
}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_SEARCH_INCLUDE_REQUEST_DETAILS
Adding SZ_SEARCH_INCLUDE_REQUEST_DETAILS includes a SEARCH_REQUEST object with the original JSON data, parsed features, and detailed candidate key usage statistics.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+ADDRESS+EMAIL",
"WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"MATCH_LEVEL_CODE": "RESOLVED"
}
}
],
"SEARCH_REQUEST": {
"JSON_DATA": "{\"NAME_FULL\": \"Robert Smith\", \"DATE_OF_BIRTH\": \"12/11/1978\", \"ADDR_FULL\": \"123 Main Street, Las Vegas NV 89132\", \"EMAIL_ADDRESS\": \"[email protected]\"}",
"SEARCH_PROFILE": "",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": -2,
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"NAME_FULL": "Robert Smith"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 0,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"DOB": [
{
"LIB_FEAT_ID": 2,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
},
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": -3,
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_FULL": "123 Main Street, Las Vegas NV 89132"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 0,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 37,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 3,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"ADDR_KEY": [
{
"LIB_FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"EMAIL_KEY": [
{
"LIB_FEAT_ID": 39,
"FEAT_DESC": "[email protected]",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEADDR_KEY": [
{
"LIB_FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEREGION_KEY": [
{
"LIB_FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
]
}
},
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_SEARCH_INCLUDE_REQUEST
Adding SZ_SEARCH_INCLUDE_REQUEST includes a SEARCH_REQUEST object with the original JSON data and parsed features, but without the detailed candidate key usage statistics.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+ADDRESS+EMAIL",
"WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"MATCH_LEVEL_CODE": "RESOLVED"
}
}
],
"SEARCH_REQUEST": {
"JSON_DATA": "{\"NAME_FULL\": \"Robert Smith\", \"DATE_OF_BIRTH\": \"12/11/1978\", \"ADDR_FULL\": \"123 Main Street, Las Vegas NV 89132\", \"EMAIL_ADDRESS\": \"[email protected]\"}",
"SEARCH_PROFILE": "",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": -2,
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"NAME_FULL": "Robert Smith"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 2,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": -3,
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_FULL": "123 Main Street, Las Vegas NV 89132"
}
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 37,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
}
}
]
}
},
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_INCLUDE_MATCH_KEY_DETAILS
Adding SZ_INCLUDE_MATCH_KEY_DETAILS includes a WHY_KEY_DETAILS object in the MATCH_INFO that breaks down the match key into its component CONFIRMATIONS, showing the specific feature comparisons that led to each token in the match key.
This sample response message was generated using SZ_INCLUDE_MATCH_KEY_DETAILS | SZ_WHY_SEARCH_DEFAULT_FLAGS
:
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+ADDRESS+EMAIL",
"WHY_KEY_DETAILS": {
"CONFIRMATIONS": [
{
"TOKEN": "NAME",
"FTYPE_CODE": "NAME",
"SCORE_BEHAVIOR": "NAME",
"SOURCE": "/SAME_NAME",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"GNR_FN": 100,
"GNR_SN": -1,
"GNR_GN": -1,
"GNR_ON": -1,
"GENERATION_MATCH": -1
},
"INBOUND_FEAT_ID": -2,
"INBOUND_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "SAME"
},
{
"TOKEN": "DOB",
"FTYPE_CODE": "DOB",
"SCORE_BEHAVIOR": "FMES",
"SOURCE": "DOB",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 2,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"SCORE_BUCKET": "SAME"
},
{
"TOKEN": "ADDRESS",
"FTYPE_CODE": "ADDRESS",
"SCORE_BEHAVIOR": "FF",
"SOURCE": "ADDRESS",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"INBOUND_FEAT_ID": -3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_ID": 3,
"CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE_BUCKET": "SAME"
},
{
"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"
}
]
},
"WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"MATCH_LEVEL_CODE": "RESOLVED",
"CANDIDATE_KEYS": {
"ADDR_KEY": [
{
"FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS"
},
{
"FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132"
}
],
"DOB": [
{
"FEAT_ID": 2,
"FEAT_DESC": "12/11/1978"
}
],
"EMAIL_KEY": [
{
"FEAT_ID": 39,
"FEAT_DESC": "[email protected]"
}
],
"NAMEADDR_KEY": [
{
"FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132"
},
{
"FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS"
}
],
"NAMEDATE_KEY": [
{
"FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132"
},
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": -3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_ID": 3,
"CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 2,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FMES"
}
],
"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": "Robert Smith",
"CANDIDATE_FEAT_ID": 1,
"CANDIDATE_FEAT_DESC": "Robert Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"GNR_FN": 100,
"GNR_SN": -1,
"GNR_GN": -1,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "NAME"
}
]
},
"DISCLOSED_RELATIONS": {}
}
}
],
"SEARCH_REQUEST": {
"JSON_DATA": "{\"NAME_FULL\": \"Robert Smith\", \"DATE_OF_BIRTH\": \"12/11/1978\", \"ADDR_FULL\": \"123 Main Street, Las Vegas NV 89132\", \"EMAIL_ADDRESS\": \"[email protected]\"}",
"SEARCH_PROFILE": "",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": -2,
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"NAME_FULL": "Robert Smith"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 0,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"DOB": [
{
"LIB_FEAT_ID": 2,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
},
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": -3,
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_FULL": "123 Main Street, Las Vegas NV 89132"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 0,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 37,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
},
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 3,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"ADDR_KEY": [
{
"LIB_FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"EMAIL_KEY": [
{
"LIB_FEAT_ID": 39,
"FEAT_DESC": "[email protected]",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEADDR_KEY": [
{
"LIB_FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
],
"NAMEREGION_KEY": [
{
"LIB_FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
},
{
"LIB_FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "N",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N"
}
]
}
},
"SEARCH_STATISTICS": [
{
"CANDIDATE_KEYS": {
"FEATURE_TYPES": [
{
"FTYPE_CODE": "DOB",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAME_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "ADDR_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "EMAIL_KEY",
"FOUND": 1,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEADDR_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEDATE_KEY",
"FOUND": 3,
"NOT_FOUND": 0,
"GENERIC": 0
},
{
"FTYPE_CODE": "NAMEREGION_KEY",
"FOUND": 2,
"NOT_FOUND": 0,
"GENERIC": 0
}
],
"SUMMARY": {
"FOUND": 12,
"NOT_FOUND": 0,
"GENERIC": 0
}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
If you have any questions, contact Senzing Support. Support is 100% FREE!