get_entity* Flags
get_entity_by_entity_id, get_entity_by_record_id
These are the control flags applicable to:
- C/C++:
Sz_getEntityByEntityID,Sz_getEntityByRecordID - C#:
GetEntity - Java:
getEntity - Python:
get_entity_by_entity_id,get_entity_by_record_id - sz_command:
get_entity_by_entity_id,get_entity_by_record_id
The default composite flag is SZ_ENTITY_DEFAULT_FLAGS.
SZ_ENTITY_DEFAULT_FLAGS
The output of SZ_ENTITY_DEFAULT_FLAGS is a composite of:
SZ_ENTITY_INCLUDE_ALL_RELATIONSSZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURESSZ_ENTITY_INCLUDE_ENTITY_NAMESZ_ENTITY_INCLUDE_RECORD_SUMMARYSZ_ENTITY_INCLUDE_RECORD_DATASZ_ENTITY_INCLUDE_RECORD_MATCHING_INFOSZ_ENTITY_INCLUDE_RELATED_ENTITY_NAMESZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARYSZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"ENTITY_NAME": "Robert Smith",
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18
},
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5
}
]
}
]
},
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
],
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"INTERNAL_ID": 18,
"MATCH_KEY": "",
"MATCH_LEVEL_CODE": "",
"ERRULE_CODE": ""
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"INTERNAL_ID": 3,
"MATCH_KEY": "+NAME+DOB+EMAIL",
"MATCH_LEVEL_CODE": "RESOLVED",
"ERRULE_CODE": "SF1_PNAME_CSTAB"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"INTERNAL_ID": 20,
"MATCH_KEY": "+NAME+DOB+ADDRESS",
"MATCH_LEVEL_CODE": "RESOLVED",
"ERRULE_CODE": "CNAME_CFF_CEXCL"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"INTERNAL_ID": 21,
"MATCH_KEY": "+NAME+DOB+PHONE",
"MATCH_LEVEL_CODE": "RESOLVED",
"ERRULE_CODE": "CNAME_CFF_CEXCL"
}
]
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 19,
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME+ADDRESS-DOB",
"ERRULE_CODE": "CNAME_CFF_DEXCL",
"IS_DISCLOSED": 0,
"IS_AMBIGUOUS": 0,
"ENTITY_NAME": "Robert E Smith Sr",
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 1
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
},
{
"ENTITY_ID": 200023,
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"MATCH_KEY": "+NAME",
"ERRULE_CODE": "SNAME",
"IS_DISCLOSED": 0,
"IS_AMBIGUOUS": 0,
"ENTITY_NAME": "Robert Smith",
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
},
{
"ENTITY_ID": 200016,
"MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
"MATCH_KEY": "+SURNAME+ADDRESS",
"ERRULE_CODE": "CFF_SURNAME",
"IS_DISCLOSED": 0,
"IS_AMBIGUOUS": 0,
"ENTITY_NAME": "Patricia Smith",
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
]
}
SZ_ENTITY_INCLUDE_ALL_RELATIONS
The output of SZ_ENTITY_INCLUDE_ALL_RELATIONS is composite of:
SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONSSZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONSSZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONSSZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 19
},
{
"ENTITY_ID": 200023
},
{
"ENTITY_ID": 200016
}
]
}
SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 200016
}
]
}
SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 10077
}
]
}
SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS
The parameter values (from our truthset) used to generate the response messages are:
- datasource_code:
REFERENCE - record_id:
2081
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 175
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 100
},
{
"ENTITY_ID": 111
}
]
}
SZ_ENTITY_INCLUDE_ALL_FEATURES
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110
}
]
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109
}
]
},
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127
}
]
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17
}
]
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5
}
]
}
]
}
}
}
SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18
},
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5
}
]
}
]
}
}
}
SZ_ENTITY_INCLUDE_ENTITY_NAME
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"ENTITY_NAME": "Robert Smith"
}
}
SZ_ENTITY_INCLUDE_RECORD_SUMMARY
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
SZ_ENTITY_INCLUDE_RECORD_DATA
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004"
}
]
}
}
SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"INTERNAL_ID": 18,
"MATCH_KEY": "",
"MATCH_LEVEL_CODE": "",
"ERRULE_CODE": ""
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"INTERNAL_ID": 3,
"MATCH_KEY": "+NAME+DOB+EMAIL",
"MATCH_LEVEL_CODE": "RESOLVED",
"ERRULE_CODE": "SF1_PNAME_CSTAB"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"INTERNAL_ID": 20,
"MATCH_KEY": "+NAME+DOB+ADDRESS",
"MATCH_LEVEL_CODE": "RESOLVED",
"ERRULE_CODE": "CNAME_CFF_CEXCL"
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"INTERNAL_ID": 21,
"MATCH_KEY": "+NAME+DOB+PHONE",
"MATCH_LEVEL_CODE": "RESOLVED",
"ERRULE_CODE": "CNAME_CFF_CEXCL"
}
]
}
}
SZ_ENTITY_INCLUDE_RECORD_JSON_DATA
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORDS": [
{
"JSON_DATA": {
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"RECORD_TYPE": "PERSON",
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Bob",
"DATE_OF_BIRTH": "11/12/1978",
"ADDR_TYPE": "HOME",
"ADDR_LINE1": "1515 Adela Lane",
"ADDR_CITY": "Las Vegas",
"ADDR_STATE": "NV",
"ADDR_POSTAL_CODE": "89111",
"PHONE_TYPE": "MOBILE",
"PHONE_NUMBER": "702-919-1300",
"DATE": "3/10/17",
"STATUS": "Inactive",
"AMOUNT": "200"
},
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
},
{
"JSON_DATA": {
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"RECORD_TYPE": "PERSON",
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Bob",
"PRIMARY_NAME_MIDDLE": "J",
"DATE_OF_BIRTH": "12/11/1978",
"EMAIL_ADDRESS": "[email protected]",
"DATE": "4/9/16",
"STATUS": "Inactive",
"AMOUNT": "300"
},
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003"
},
{
"JSON_DATA": {
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"RECORD_TYPE": "PERSON",
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "B",
"DATE_OF_BIRTH": "11/12/1979",
"ADDR_TYPE": "HOME",
"ADDR_LINE1": "1515 Adela Ln",
"ADDR_CITY": "Las Vegas",
"ADDR_STATE": "NV",
"ADDR_POSTAL_CODE": "89132",
"EMAIL_ADDRESS": "[email protected]",
"DATE": "1/5/15",
"STATUS": "Inactive",
"AMOUNT": "400"
},
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004"
},
{
"JSON_DATA": {
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"RECORD_TYPE": "PERSON",
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Robert",
"DATE_OF_BIRTH": "12/11/1978",
"ADDR_TYPE": "MAILING",
"ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
"PHONE_TYPE": "HOME",
"PHONE_NUMBER": "702-919-1300",
"DATE": "1/2/18",
"STATUS": "Active",
"AMOUNT": "100"
},
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
}
]
}
}
SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"UNMAPPED_DATA": {
"DATE": "3/10/17",
"STATUS": "Inactive",
"AMOUNT": "200"
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"UNMAPPED_DATA": {
"DATE": "4/9/16",
"STATUS": "Inactive",
"AMOUNT": "300"
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"UNMAPPED_DATA": {
"DATE": "1/5/15",
"STATUS": "Inactive",
"AMOUNT": "400"
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"UNMAPPED_DATA": {
"DATE": "1/2/18",
"STATUS": "Active",
"AMOUNT": "100"
}
}
]
}
}
SZ_ENTITY_INCLUDE_RECORD_FEATURES
The
SZ_ENTITY_INCLUDE_RECORD_FEATURES engine flag now returns a FEATURE_IDS section as of v4.1.0, whereas in v4.0.0 it returned a FEATURES section. The contents are unchanged; only the section name has changed.Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"FEATURE_IDS": [
{
"LIB_FEAT_ID": 3
},
{
"LIB_FEAT_ID": 7
},
{
"LIB_FEAT_ID": 77,
"USAGE_TYPE": "PRIMARY"
},
{
"LIB_FEAT_ID": 78
},
{
"LIB_FEAT_ID": 79,
"USAGE_TYPE": "HOME"
}
]
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"FEATURE_IDS": [
{
"LIB_FEAT_ID": 1,
"USAGE_TYPE": "PRIMARY"
},
{
"LIB_FEAT_ID": 2
},
{
"LIB_FEAT_ID": 3
},
{
"LIB_FEAT_ID": 7
}
]
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"FEATURE_IDS": [
{
"LIB_FEAT_ID": 2
},
{
"LIB_FEAT_ID": 7
},
{
"LIB_FEAT_ID": 90,
"USAGE_TYPE": "PRIMARY"
},
{
"LIB_FEAT_ID": 91,
"USAGE_TYPE": "MAILING"
},
{
"LIB_FEAT_ID": 92,
"USAGE_TYPE": "HOME"
}
]
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"FEATURE_IDS": [
{
"LIB_FEAT_ID": 7
},
{
"LIB_FEAT_ID": 92,
"USAGE_TYPE": "MOBILE"
},
{
"LIB_FEAT_ID": 101,
"USAGE_TYPE": "PRIMARY"
},
{
"LIB_FEAT_ID": 102
},
{
"LIB_FEAT_ID": 103,
"USAGE_TYPE": "HOME"
}
]
}
]
}
}
SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 108,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Bob Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Bob"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 109,
"FEAT_DESC": "11/12/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "11/12/1978"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"ATTRIBUTES": {
"ADDR_LINE1": "1515 Adela Lane",
"ADDR_CITY": "Las Vegas",
"ADDR_STATE": "NV",
"ADDR_POSTAL_CODE": "89111"
}
}
],
"PHONE": [
{
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC": "702-919-1300",
"ATTRIBUTES": {
"PHONE_NUMBER": "702-919-1300"
}
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
]
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 17,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Bob J Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Bob",
"PRIMARY_NAME_MIDDLE": "J"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 18,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
}
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 19,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
}
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
]
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "B Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "B"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 128,
"FEAT_DESC": "11/12/1979",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "11/12/1979"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 129,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_LINE1": "1515 Adela Ln",
"ADDR_CITY": "Las Vegas",
"ADDR_STATE": "NV",
"ADDR_POSTAL_CODE": "89132"
}
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 19,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
}
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
]
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Robert"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 18,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_LINE1": "123 Main Street, Las Vegas NV 89132"
}
}
],
"PHONE": [
{
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "702-919-1300",
"ATTRIBUTES": {
"PHONE_NUMBER": "702-919-1300"
}
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
]
}
}
]
}
}
SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME
NOTE: The SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.
This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME and SZ_ENTITY_INCLUDE_ALL_FEATURES:
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110
}
]
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109
}
]
},
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127
}
]
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17
}
]
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5
}
]
}
]
}
}
}
SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO
NOTE: The SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.
This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO and SZ_ENTITY_INCLUDE_ALL_FEATURES:
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110
}
]
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109
}
]
},
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127
}
]
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17
}
]
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5
}
]
}
]
}
}
}
SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY
NOTE: The SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.
This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY and SZ_ENTITY_INCLUDE_ALL_RELATIONS:
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 19,
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 1
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
},
{
"ENTITY_ID": 200023,
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
},
{
"ENTITY_ID": 200016,
"RECORD_SUMMARY": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
]
}
SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA
NOTE: The SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.
This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA and SZ_ENTITY_INCLUDE_ALL_RELATIONS:
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3
},
"RELATED_ENTITIES": [
{
"ENTITY_ID": 19,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1005"
},
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_ID": "1006"
}
]
},
{
"ENTITY_ID": 200023,
"RECORDS": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_ID": "1008"
}
]
},
{
"ENTITY_ID": 200016,
"RECORDS": [
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_ID": "1007"
}
]
}
]
}
SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
NOTE: The SZ_ENTITY_INCLUDE_INTERNAL_FEATURES flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_RECORD_FEATURES, or SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS.
This sample response message was generated using SZ_ENTITY_INCLUDE_INTERNAL_FEATURES and SZ_ENTITY_INCLUDE_ALL_FEATURES:
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 108,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Bob Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Bob"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 109,
"FEAT_DESC": "11/12/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "11/12/1978"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"ATTRIBUTES": {
"ADDR_LINE1": "1515 Adela Lane",
"ADDR_CITY": "Las Vegas",
"ADDR_STATE": "NV",
"ADDR_POSTAL_CODE": "89111"
}
}
],
"PHONE": [
{
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC": "702-919-1300",
"ATTRIBUTES": {
"PHONE_NUMBER": "702-919-1300"
}
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 20,
"FEAT_DESC": "RPRT|SM0"
},
{
"LIB_FEAT_ID": 21,
"FEAT_DESC": "PP|SM0"
}
],
"ADDR_KEY": [
{
"LIB_FEAT_ID": 112,
"FEAT_DESC": "1515|ATL||89111"
},
{
"LIB_FEAT_ID": 113,
"FEAT_DESC": "1515|ATL||LS FKS"
}
],
"PHONE_KEY": [
{
"LIB_FEAT_ID": 114,
"FEAT_DESC": "7029191300"
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
],
"NAMEADDR_KEY": [
{
"LIB_FEAT_ID": 115,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS"
},
{
"LIB_FEAT_ID": 116,
"FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111"
},
{
"LIB_FEAT_ID": 117,
"FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS"
},
{
"LIB_FEAT_ID": 118,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 119,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178"
},
{
"LIB_FEAT_ID": 24,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"LIB_FEAT_ID": 26,
"FEAT_DESC": "PP|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 28,
"FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211"
},
{
"LIB_FEAT_ID": 29,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 120,
"FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178"
}
],
"NAMEREGION_KEY": [
{
"LIB_FEAT_ID": 121,
"FEAT_DESC": "RPRT|SM0|POST=89111"
},
{
"LIB_FEAT_ID": 122,
"FEAT_DESC": "PP|SM0|POST=89111"
},
{
"LIB_FEAT_ID": 123,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
},
{
"LIB_FEAT_ID": 124,
"FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAMEPHONE_KEY": [
{
"LIB_FEAT_ID": 125,
"FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300"
},
{
"LIB_FEAT_ID": 126,
"FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300"
}
]
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1003",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 17,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Bob J Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Bob",
"PRIMARY_NAME_MIDDLE": "J"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 18,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
}
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 19,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
}
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 20,
"FEAT_DESC": "RPRT|SM0"
},
{
"LIB_FEAT_ID": 21,
"FEAT_DESC": "PP|SM0"
},
{
"LIB_FEAT_ID": 22,
"FEAT_DESC": "J|PP|SM0"
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
],
"EMAIL_KEY": [
{
"LIB_FEAT_ID": 23,
"FEAT_DESC": "[email protected]"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 24,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"LIB_FEAT_ID": 25,
"FEAT_DESC": "J|PP|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 26,
"FEAT_DESC": "PP|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 27,
"FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278"
},
{
"LIB_FEAT_ID": 28,
"FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211"
},
{
"LIB_FEAT_ID": 29,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 30,
"FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278"
},
{
"LIB_FEAT_ID": 31,
"FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211"
},
{
"LIB_FEAT_ID": 32,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
}
]
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1004",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "B Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "B"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 128,
"FEAT_DESC": "11/12/1979",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "11/12/1979"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 129,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_LINE1": "1515 Adela Ln",
"ADDR_CITY": "Las Vegas",
"ADDR_STATE": "NV",
"ADDR_POSTAL_CODE": "89132"
}
}
],
"EMAIL": [
{
"LIB_FEAT_ID": 19,
"FEAT_DESC": "[email protected]",
"ATTRIBUTES": {
"EMAIL_ADDRESS": "[email protected]"
}
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 130,
"FEAT_DESC": "B|SM0"
}
],
"ADDR_KEY": [
{
"LIB_FEAT_ID": 113,
"FEAT_DESC": "1515|ATL||LS FKS"
},
{
"LIB_FEAT_ID": 132,
"FEAT_DESC": "1515|ATL||89132"
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
],
"EMAIL_KEY": [
{
"LIB_FEAT_ID": 23,
"FEAT_DESC": "[email protected]"
}
],
"NAMEADDR_KEY": [
{
"LIB_FEAT_ID": 133,
"FEAT_DESC": "B|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89132"
},
{
"LIB_FEAT_ID": 134,
"FEAT_DESC": "B|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 135,
"FEAT_DESC": "B|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 136,
"FEAT_DESC": "B|SM0|DOB.MMYY_HASH=1179"
},
{
"LIB_FEAT_ID": 137,
"FEAT_DESC": "B|SM0|DOB.MMDD_HASH=1211"
}
],
"NAMEREGION_KEY": [
{
"LIB_FEAT_ID": 138,
"FEAT_DESC": "B|SM0|ADDRESS.CITY_STD=LS FKS"
},
{
"LIB_FEAT_ID": 139,
"FEAT_DESC": "B|SM0|POST=89132"
}
]
}
},
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001",
"FEATURES": {
"NAME": [
{
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Robert"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 18,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"ATTRIBUTES": {
"ADDR_LINE1": "123 Main Street, Las Vegas NV 89132"
}
}
],
"PHONE": [
{
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "702-919-1300",
"ATTRIBUTES": {
"PHONE_NUMBER": "702-919-1300"
}
}
],
"NAME_KEY": [
{
"LIB_FEAT_ID": 20,
"FEAT_DESC": "RPRT|SM0"
}
],
"ADDR_KEY": [
{
"LIB_FEAT_ID": 142,
"FEAT_DESC": "123|MN||LS FKS"
},
{
"LIB_FEAT_ID": 98,
"FEAT_DESC": "123|MN||89132"
}
],
"PHONE_KEY": [
{
"LIB_FEAT_ID": 114,
"FEAT_DESC": "7029191300"
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 5,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
],
"NAMEADDR_KEY": [
{
"LIB_FEAT_ID": 102,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132"
},
{
"LIB_FEAT_ID": 143,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS"
}
],
"NAMEDATE_KEY": [
{
"LIB_FEAT_ID": 24,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"LIB_FEAT_ID": 29,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"LIB_FEAT_ID": 32,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
}
],
"NAMEREGION_KEY": [
{
"LIB_FEAT_ID": 104,
"FEAT_DESC": "RPRT|SM0|POST=89132"
},
{
"LIB_FEAT_ID": 123,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAMEPHONE_KEY": [
{
"LIB_FEAT_ID": 126,
"FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300"
}
]
}
}
]
}
}
SZ_ENTITY_INCLUDE_FEATURE_STATS
NOTE: The SZ_ENTITY_INCLUDE_FEATURE_STATS flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, or SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES.
This sample response message was generated using SZ_ENTITY_INCLUDE_FEATURE_STATS and SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS:
Click to expand response JSON
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 3,
"FEATURES": {
"ADDRESS": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"LIB_FEAT_ID": 110,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
},
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
"LIB_FEAT_ID": 129,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
},
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USAGE_TYPE": "MAILING",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"LIB_FEAT_ID": 141,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
}
],
"DOB": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1978",
"LIB_FEAT_ID": 109,
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
},
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "11/12/1979",
"LIB_FEAT_ID": 128,
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
},
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "12/11/1978",
"LIB_FEAT_ID": 18,
"USED_FOR_CAND": "Y",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
}
],
"EMAIL": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "[email protected]",
"LIB_FEAT_ID": 19,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
}
],
"NAME": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "B Smith",
"LIB_FEAT_ID": 127,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "Y"
}
]
},
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob J Smith",
"LIB_FEAT_ID": 17,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 1,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
},
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Bob Smith",
"LIB_FEAT_ID": 108,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "Y"
}
]
},
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "Robert Smith",
"LIB_FEAT_ID": 140,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 3,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
}
],
"PHONE": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "HOME",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
},
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USAGE_TYPE": "MOBILE",
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "702-919-1300",
"LIB_FEAT_ID": 111,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 2,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
}
],
"RECORD_TYPE": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"FEAT_DESC_VALUES": [
{
"FEAT_DESC": "PERSON",
"LIB_FEAT_ID": 5,
"USED_FOR_CAND": "N",
"USED_FOR_SCORING": "Y",
"ENTITY_COUNT": 300,
"CANDIDATE_CAP_REACHED": "N",
"SCORING_CAP_REACHED": "N",
"SUPPRESSED": "N"
}
]
}
]
}
}
}