how_entity_by_entity_id Flags
how_entity_by_entity_id
These are the control flags applicable to:
- C/C++:
Sz_howEntityByEntityID - C#:
HowEntity - Java:
howEntity - Python:
how_entity_by_entity_id - sz_command:
how_entity_by_entity_id
The default composite flag is SZ_HOW_ENTITY_DEFAULT_FLAGS, the equivalent of SZ_INCLUDE_FEATURE_SCORES.
SZ_HOW_ENTITY_DEFAULT_FLAGS
Click to expand response JSON
{
"HOW_RESULTS":
{
"RESOLUTION_STEPS":
[
{
"STEP": 1,
"VIRTUAL_ENTITY_1":
{
"VIRTUAL_ENTITY_ID": "V100001",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100001,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
}
]
}
]
},
"VIRTUAL_ENTITY_2":
{
"VIRTUAL_ENTITY_ID": "V100007",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100007,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004"
}
]
}
]
},
"INBOUND_VIRTUAL_ENTITY_ID": "V100007",
"RESULT_VIRTUAL_ENTITY_ID": "V100001-S1",
"MATCH_INFO":
{
"MATCH_KEY": "+NAME+DOB+ADDRESS",
"ERRULE_CODE": "CNAME_CFF_CEXCL",
"FEATURE_SCORES":
{
"ADDRESS":
[
{
"INBOUND_FEAT_ID": 100067,
"INBOUND_FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "HOME",
"CANDIDATE_FEAT_ID": 100079,
"CANDIDATE_FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"CANDIDATE_FEAT_USAGE_TYPE": "HOME",
"SCORE": 96,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 96
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB":
[
{
"INBOUND_FEAT_ID": 100066,
"INBOUND_FEAT_DESC": "11/12/1979",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100078,
"CANDIDATE_FEAT_DESC": "11/12/1978",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 92,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 92
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "FMES"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": 100065,
"INBOUND_FEAT_DESC": "B Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 100077,
"CANDIDATE_FEAT_DESC": "Bob Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 92,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 92,
"GNR_GN": 85,
"GNR_ON": -1,
"GNR_SN": 100
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"RECORD_TYPE":
[
{
"INBOUND_FEAT_ID": 7,
"INBOUND_FEAT_DESC": "PERSON",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 7,
"CANDIDATE_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
}
}
},
{
"STEP": 2,
"VIRTUAL_ENTITY_1":
{
"VIRTUAL_ENTITY_ID": "V100001-S1",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100001,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
}
]
},
{
"INTERNAL_ID": 100007,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004"
}
]
}
]
},
"VIRTUAL_ENTITY_2":
{
"VIRTUAL_ENTITY_ID": "V100002",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100002,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
}
]
}
]
},
"INBOUND_VIRTUAL_ENTITY_ID": "V100001-S1",
"RESULT_VIRTUAL_ENTITY_ID": "V100001-S2",
"MATCH_INFO":
{
"MATCH_KEY": "+NAME+DOB+PHONE+EMAIL",
"ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
"FEATURE_SCORES":
{
"ADDRESS":
[
{
"INBOUND_FEAT_ID": 100067,
"INBOUND_FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "HOME",
"CANDIDATE_FEAT_ID": 100043,
"CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 33,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 33
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "FF"
},
{
"INBOUND_FEAT_ID": 100079,
"INBOUND_FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"INBOUND_FEAT_USAGE_TYPE": "HOME",
"CANDIDATE_FEAT_ID": 100043,
"CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 42,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 42
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB":
[
{
"INBOUND_FEAT_ID": 100066,
"INBOUND_FEAT_DESC": "11/12/1979",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100002,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 88,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 88
},
"SCORE_BUCKET": "PLAUSIBLE",
"SCORE_BEHAVIOR": "FMES"
},
{
"INBOUND_FEAT_ID": 100078,
"INBOUND_FEAT_DESC": "11/12/1978",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100002,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 95,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 95
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "FMES"
}
],
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "[email protected]",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100003,
"CANDIDATE_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": 100077,
"INBOUND_FEAT_DESC": "Bob Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"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": 95,
"GNR_ON": -1,
"GNR_SN": 100
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"PHONE":
[
{
"INBOUND_FEAT_ID": 100080,
"INBOUND_FEAT_DESC": "702-919-1300",
"INBOUND_FEAT_USAGE_TYPE": "MOBILE",
"CANDIDATE_FEAT_ID": 100080,
"CANDIDATE_FEAT_DESC": "702-919-1300",
"CANDIDATE_FEAT_USAGE_TYPE": "HOME",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"RECORD_TYPE":
[
{
"INBOUND_FEAT_ID": 7,
"INBOUND_FEAT_DESC": "PERSON",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 7,
"CANDIDATE_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
}
}
},
{
"STEP": 3,
"VIRTUAL_ENTITY_1":
{
"VIRTUAL_ENTITY_ID": "V100001-S2",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100001,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
}
]
},
{
"INTERNAL_ID": 100002,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
}
]
},
{
"INTERNAL_ID": 100007,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004"
}
]
}
]
},
"VIRTUAL_ENTITY_2":
{
"VIRTUAL_ENTITY_ID": "V100004",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100004,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003"
}
]
}
]
},
"INBOUND_VIRTUAL_ENTITY_ID": "V100001-S2",
"RESULT_VIRTUAL_ENTITY_ID": "V100001-S3",
"MATCH_INFO":
{
"MATCH_KEY": "+NAME+DOB+EMAIL",
"ERRULE_CODE": "SF1_PNAME_CSTAB",
"FEATURE_SCORES":
{
"DOB":
[
{
"INBOUND_FEAT_ID": 100002,
"INBOUND_FEAT_DESC": "12/11/1978",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100002,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FMES"
}
],
"EMAIL":
[
{
"INBOUND_FEAT_ID": 100003,
"INBOUND_FEAT_DESC": "[email protected]",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 100003,
"CANDIDATE_FEAT_DESC": "[email protected]",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "F1"
}
],
"NAME":
[
{
"INBOUND_FEAT_ID": 9,
"INBOUND_FEAT_DESC": "Robert Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 100001,
"CANDIDATE_FEAT_DESC": "Bob J Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 90,
"ADDITIONAL_SCORES":
{
"GENERATION_MATCH": -1,
"GNR_FN": 90,
"GNR_GN": 88,
"GNR_ON": -1,
"GNR_SN": 100
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
},
{
"INBOUND_FEAT_ID": 100077,
"INBOUND_FEAT_DESC": "Bob Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"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": 93,
"GNR_ON": -1,
"GNR_SN": 100
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"RECORD_TYPE":
[
{
"INBOUND_FEAT_ID": 7,
"INBOUND_FEAT_DESC": "PERSON",
"INBOUND_FEAT_USAGE_TYPE": "",
"CANDIDATE_FEAT_ID": 7,
"CANDIDATE_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_USAGE_TYPE": "",
"SCORE": 100,
"ADDITIONAL_SCORES":
{
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
}
}
}
],
"FINAL_STATE":
{
"NEED_REEVALUATION": 0,
"VIRTUAL_ENTITIES":
[
{
"VIRTUAL_ENTITY_ID": "V100001-S3",
"MEMBER_RECORDS":
[
{
"INTERNAL_ID": 100001,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
}
]
},
{
"INTERNAL_ID": 100002,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
}
]
},
{
"INTERNAL_ID": 100004,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003"
}
]
},
{
"INTERNAL_ID": 100007,
"RECORDS":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004"
}
]
}
]
}
]
}
}
}