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:

Click to expand response JSON Click to collapse
{
  "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
      }
    ],
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": ""
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      },
      {
        "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": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      }
    ]
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "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": 145,
      "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": 144,
      "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_CORE_FLAGS

SZ_ENTITY_CORE_FLAGS is the core subset of SZ_ENTITY_DEFAULT_FLAGS — it includes entity-level data without related entities. It is a composite of:

Click to expand response JSON Click to collapse
{
  "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
      }
    ],
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": ""
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      },
      {
        "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": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_ALL_RELATIONS

The output of SZ_ENTITY_INCLUDE_ALL_RELATIONS is composite of:

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5
    },
    {
      "ENTITY_ID": 145
    },
    {
      "ENTITY_ID": 144
    }
  ]
}

SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS

Include possibly-same relations for entities.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5
    },
    {
      "ENTITY_ID": 145
    }
  ]
}

Include possibly-related relations for entities.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 144
    }
  ]
}

SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS

Include name-only relations for entities.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": []
}

SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS

Include disclosed relations for entities.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 97
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 96
    },
    {
      "ENTITY_ID": 98
    },
    {
      "ENTITY_ID": 99
    },
    {
      "ENTITY_ID": 129
    },
    {
      "ENTITY_ID": 130
    }
  ]
}

SZ_ENTITY_INCLUDE_ALL_FEATURES

Include all features for entities.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "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,
          "USAGE_TYPE": "HOME",
          "FEAT_DESC_VALUES": [
            {
              "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/1978",
          "LIB_FEAT_ID": 19,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "11/12/1978",
              "LIB_FEAT_ID": 19
            }
          ]
        },
        {
          "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
            }
          ]
        }
      ],
      "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": "Bob J Smith",
          "LIB_FEAT_ID": 36,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Bob J Smith",
              "LIB_FEAT_ID": 36
            }
          ]
        },
        {
          "FEAT_DESC": "Bob Smith",
          "LIB_FEAT_ID": 18,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Bob Smith",
              "LIB_FEAT_ID": 18
            }
          ]
        },
        {
          "FEAT_DESC": "Robert Smith",
          "LIB_FEAT_ID": 1,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Robert Smith",
              "LIB_FEAT_ID": 1
            }
          ]
        }
      ],
      "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
            }
          ]
        }
      ]
    }
  }
}

SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES

Include representative features for entities.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "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
            }
          ]
        }
      ]
    }
  }
}

SZ_ENTITY_INCLUDE_ENTITY_NAME

Include the name of the entity.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "ENTITY_NAME": "Robert Smith"
  }
}

SZ_ENTITY_INCLUDE_RECORD_SUMMARY

Include the record summary of the entity.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "RECORD_SUMMARY": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_COUNT": 4
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_RECORD_DATA

Include the basic record data for the entity.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "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

Include the record matching info for the entity or record.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": ""
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      },
      {
        "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": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_RECORD_JSON_DATA

Include the record JSON data for the entity or record.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "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": "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"
      },
      {
        "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"
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

Include the record unmapped data for the entity or record.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "UNMAPPED_DATA": {
          "DATE": "3/10/17",
          "STATUS": "Inactive",
          "AMOUNT": "200"
        }
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "UNMAPPED_DATA": {
          "DATE": "1/2/18",
          "STATUS": "Active",
          "AMOUNT": "100"
        }
      },
      {
        "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"
        }
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_RECORD_FEATURES

Include the feature identifiers at the record level, referencing the entity 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 Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "FEATURE_IDS": [
          {
            "LIB_FEAT_ID": 4,
            "USAGE_TYPE": "MOBILE"
          },
          {
            "LIB_FEAT_ID": 9
          },
          {
            "LIB_FEAT_ID": 18,
            "USAGE_TYPE": "PRIMARY"
          },
          {
            "LIB_FEAT_ID": 19
          },
          {
            "LIB_FEAT_ID": 20,
            "USAGE_TYPE": "HOME"
          }
        ]
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "FEATURE_IDS": [
          {
            "LIB_FEAT_ID": 1,
            "USAGE_TYPE": "PRIMARY"
          },
          {
            "LIB_FEAT_ID": 2
          },
          {
            "LIB_FEAT_ID": 3,
            "USAGE_TYPE": "MAILING"
          },
          {
            "LIB_FEAT_ID": 4,
            "USAGE_TYPE": "HOME"
          },
          {
            "LIB_FEAT_ID": 9
          }
        ]
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1003",
        "FEATURE_IDS": [
          {
            "LIB_FEAT_ID": 2
          },
          {
            "LIB_FEAT_ID": 9
          },
          {
            "LIB_FEAT_ID": 36,
            "USAGE_TYPE": "PRIMARY"
          },
          {
            "LIB_FEAT_ID": 37
          }
        ]
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1004",
        "FEATURE_IDS": [
          {
            "LIB_FEAT_ID": 9
          },
          {
            "LIB_FEAT_ID": 37
          },
          {
            "LIB_FEAT_ID": 44,
            "USAGE_TYPE": "PRIMARY"
          },
          {
            "LIB_FEAT_ID": 45
          },
          {
            "LIB_FEAT_ID": 46,
            "USAGE_TYPE": "HOME"
          }
        ]
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

Include full feature details at the record level of an entity response or in a record response.

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "FEATURES": {
          "NAME": [
            {
              "LIB_FEAT_ID": 18,
              "USAGE_TYPE": "PRIMARY",
              "FEAT_DESC": "Bob Smith",
              "ATTRIBUTES": {
                "PRIMARY_NAME_LAST": "Smith",
                "PRIMARY_NAME_FIRST": "Bob"
              }
            }
          ],
          "DOB": [
            {
              "LIB_FEAT_ID": 19,
              "FEAT_DESC": "11/12/1978",
              "ATTRIBUTES": {
                "DATE_OF_BIRTH": "11/12/1978"
              }
            }
          ],
          "ADDRESS": [
            {
              "LIB_FEAT_ID": 20,
              "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": 4,
              "USAGE_TYPE": "MOBILE",
              "FEAT_DESC": "702-919-1300",
              "ATTRIBUTES": {
                "PHONE_NUMBER": "702-919-1300"
              }
            }
          ],
          "RECORD_TYPE": [
            {
              "LIB_FEAT_ID": 9,
              "FEAT_DESC": "PERSON",
              "ATTRIBUTES": {
                "RECORD_TYPE": "PERSON"
              }
            }
          ]
        }
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "FEATURES": {
          "NAME": [
            {
              "LIB_FEAT_ID": 1,
              "USAGE_TYPE": "PRIMARY",
              "FEAT_DESC": "Robert Smith",
              "ATTRIBUTES": {
                "PRIMARY_NAME_LAST": "Smith",
                "PRIMARY_NAME_FIRST": "Robert"
              }
            }
          ],
          "DOB": [
            {
              "LIB_FEAT_ID": 2,
              "FEAT_DESC": "12/11/1978",
              "ATTRIBUTES": {
                "DATE_OF_BIRTH": "12/11/1978"
              }
            }
          ],
          "ADDRESS": [
            {
              "LIB_FEAT_ID": 3,
              "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": 4,
              "USAGE_TYPE": "HOME",
              "FEAT_DESC": "702-919-1300",
              "ATTRIBUTES": {
                "PHONE_NUMBER": "702-919-1300"
              }
            }
          ],
          "RECORD_TYPE": [
            {
              "LIB_FEAT_ID": 9,
              "FEAT_DESC": "PERSON",
              "ATTRIBUTES": {
                "RECORD_TYPE": "PERSON"
              }
            }
          ]
        }
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1003",
        "FEATURES": {
          "NAME": [
            {
              "LIB_FEAT_ID": 36,
              "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": 2,
              "FEAT_DESC": "12/11/1978",
              "ATTRIBUTES": {
                "DATE_OF_BIRTH": "12/11/1978"
              }
            }
          ],
          "EMAIL": [
            {
              "LIB_FEAT_ID": 37,
              "FEAT_DESC": "[email protected]",
              "ATTRIBUTES": {
                "EMAIL_ADDRESS": "[email protected]"
              }
            }
          ],
          "RECORD_TYPE": [
            {
              "LIB_FEAT_ID": 9,
              "FEAT_DESC": "PERSON",
              "ATTRIBUTES": {
                "RECORD_TYPE": "PERSON"
              }
            }
          ]
        }
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1004",
        "FEATURES": {
          "NAME": [
            {
              "LIB_FEAT_ID": 44,
              "USAGE_TYPE": "PRIMARY",
              "FEAT_DESC": "B Smith",
              "ATTRIBUTES": {
                "PRIMARY_NAME_LAST": "Smith",
                "PRIMARY_NAME_FIRST": "B"
              }
            }
          ],
          "DOB": [
            {
              "LIB_FEAT_ID": 45,
              "FEAT_DESC": "11/12/1979",
              "ATTRIBUTES": {
                "DATE_OF_BIRTH": "11/12/1979"
              }
            }
          ],
          "ADDRESS": [
            {
              "LIB_FEAT_ID": 46,
              "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": 37,
              "FEAT_DESC": "[email protected]",
              "ATTRIBUTES": {
                "EMAIL_ADDRESS": "[email protected]"
              }
            }
          ],
          "RECORD_TYPE": [
            {
              "LIB_FEAT_ID": 9,
              "FEAT_DESC": "PERSON",
              "ATTRIBUTES": {
                "RECORD_TYPE": "PERSON"
              }
            }
          ]
        }
      }
    ]
  }
}

Include the name of the related entities.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME | SZ_ENTITY_INCLUDE_ALL_RELATIONS :

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "ENTITY_NAME": "Robert E Smith Sr"
    },
    {
      "ENTITY_ID": 145,
      "ENTITY_NAME": "Robert Smith"
    },
    {
      "ENTITY_ID": 144,
      "ENTITY_NAME": "Patricia Smith"
    }
  ]
}

Include the record matching info of the related entities.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO | SZ_ENTITY_INCLUDE_ALL_RELATIONS :

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "ENTITY_ID": 145,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+SURNAME+ADDRESS",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    }
  ]
}

Include the record summary of the related entities.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY | SZ_ENTITY_INCLUDE_ALL_RELATIONS :

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "RECORD_SUMMARY": [
        {
          "DATA_SOURCE": "CUSTOMERS",
          "RECORD_COUNT": 1
        },
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_COUNT": 1
        }
      ]
    },
    {
      "ENTITY_ID": 145,
      "RECORD_SUMMARY": [
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_COUNT": 1
        }
      ]
    },
    {
      "ENTITY_ID": 144,
      "RECORD_SUMMARY": [
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_COUNT": 1
        }
      ]
    }
  ]
}

Include the basic record data of the related entities.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA | SZ_ENTITY_INCLUDE_ALL_RELATIONS :

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "RECORDS": [
        {
          "DATA_SOURCE": "CUSTOMERS",
          "RECORD_ID": "1005"
        },
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_ID": "1006"
        }
      ]
    },
    {
      "ENTITY_ID": 145,
      "RECORDS": [
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_ID": "1008"
        }
      ]
    },
    {
      "ENTITY_ID": 144,
      "RECORDS": [
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_ID": "1007"
        }
      ]
    }
  ]
}

SZ_ENTITY_INCLUDE_INTERNAL_FEATURES

Include internal features in an entity response or record response.

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 | SZ_ENTITY_INCLUDE_ALL_FEATURES :

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "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,
          "USAGE_TYPE": "HOME",
          "FEAT_DESC_VALUES": [
            {
              "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
            }
          ]
        }
      ],
      "ADDR_KEY": [
        {
          "FEAT_DESC": "123|MN||89132",
          "LIB_FEAT_ID": 7,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "123|MN||89132",
              "LIB_FEAT_ID": 7
            }
          ]
        },
        {
          "FEAT_DESC": "123|MN||LS FKS",
          "LIB_FEAT_ID": 6,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "123|MN||LS FKS",
              "LIB_FEAT_ID": 6
            }
          ]
        },
        {
          "FEAT_DESC": "1515|ATL||89111",
          "LIB_FEAT_ID": 22,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "1515|ATL||89111",
              "LIB_FEAT_ID": 22
            }
          ]
        },
        {
          "FEAT_DESC": "1515|ATL||89132",
          "LIB_FEAT_ID": 48,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "1515|ATL||89132",
              "LIB_FEAT_ID": 48
            }
          ]
        },
        {
          "FEAT_DESC": "1515|ATL||LS FKS",
          "LIB_FEAT_ID": 23,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "1515|ATL||LS FKS",
              "LIB_FEAT_ID": 23
            }
          ]
        }
      ],
      "DOB": [
        {
          "FEAT_DESC": "11/12/1978",
          "LIB_FEAT_ID": 19,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "11/12/1978",
              "LIB_FEAT_ID": 19
            }
          ]
        },
        {
          "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
            }
          ]
        }
      ],
      "EMAIL": [
        {
          "FEAT_DESC": "[email protected]",
          "LIB_FEAT_ID": 37,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "[email protected]",
              "LIB_FEAT_ID": 37
            }
          ]
        }
      ],
      "EMAIL_KEY": [
        {
          "FEAT_DESC": "[email protected]",
          "LIB_FEAT_ID": 39,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "[email protected]",
              "LIB_FEAT_ID": 39
            }
          ]
        }
      ],
      "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": "Bob J Smith",
          "LIB_FEAT_ID": 36,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Bob J Smith",
              "LIB_FEAT_ID": 36
            }
          ]
        },
        {
          "FEAT_DESC": "Bob Smith",
          "LIB_FEAT_ID": 18,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Bob Smith",
              "LIB_FEAT_ID": 18
            }
          ]
        },
        {
          "FEAT_DESC": "Robert Smith",
          "LIB_FEAT_ID": 1,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Robert Smith",
              "LIB_FEAT_ID": 1
            }
          ]
        }
      ],
      "NAMEADDR_KEY": [
        {
          "FEAT_DESC": "B|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89132",
          "LIB_FEAT_ID": 49,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89132",
              "LIB_FEAT_ID": 49
            }
          ]
        },
        {
          "FEAT_DESC": "B|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
          "LIB_FEAT_ID": 50,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
              "LIB_FEAT_ID": 50
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
          "LIB_FEAT_ID": 25,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
              "LIB_FEAT_ID": 25
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
          "LIB_FEAT_ID": 26,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
              "LIB_FEAT_ID": 26
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
          "LIB_FEAT_ID": 10,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
              "LIB_FEAT_ID": 10
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
          "LIB_FEAT_ID": 11,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
              "LIB_FEAT_ID": 11
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
          "LIB_FEAT_ID": 27,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
              "LIB_FEAT_ID": 27
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
          "LIB_FEAT_ID": 24,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
              "LIB_FEAT_ID": 24
            }
          ]
        }
      ],
      "NAMEDATE_KEY": [
        {
          "FEAT_DESC": "B|SM0|DOB.MMDD_HASH=1211",
          "LIB_FEAT_ID": 53,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|DOB.MMDD_HASH=1211",
              "LIB_FEAT_ID": 53
            }
          ]
        },
        {
          "FEAT_DESC": "B|SM0|DOB.MMYY_HASH=1179",
          "LIB_FEAT_ID": 52,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|DOB.MMYY_HASH=1179",
              "LIB_FEAT_ID": 52
            }
          ]
        },
        {
          "FEAT_DESC": "B|SM0|DOB=71211",
          "LIB_FEAT_ID": 51,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|DOB=71211",
              "LIB_FEAT_ID": 51
            }
          ]
        },
        {
          "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
          "LIB_FEAT_ID": 43,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
              "LIB_FEAT_ID": 43
            }
          ]
        },
        {
          "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
          "LIB_FEAT_ID": 41,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
              "LIB_FEAT_ID": 41
            }
          ]
        },
        {
          "FEAT_DESC": "J|PP|SM0|DOB=71211",
          "LIB_FEAT_ID": 40,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "J|PP|SM0|DOB=71211",
              "LIB_FEAT_ID": 40
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
          "LIB_FEAT_ID": 30,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
              "LIB_FEAT_ID": 30
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
          "LIB_FEAT_ID": 31,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
              "LIB_FEAT_ID": 31
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
          "LIB_FEAT_ID": 42,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
              "LIB_FEAT_ID": 42
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|DOB=71211",
          "LIB_FEAT_ID": 29,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|DOB=71211",
              "LIB_FEAT_ID": 29
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
          "LIB_FEAT_ID": 12,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
              "LIB_FEAT_ID": 12
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
          "LIB_FEAT_ID": 28,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
              "LIB_FEAT_ID": 28
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
          "LIB_FEAT_ID": 14,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
              "LIB_FEAT_ID": 14
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|DOB=71211",
          "LIB_FEAT_ID": 13,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|DOB=71211",
              "LIB_FEAT_ID": 13
            }
          ]
        }
      ],
      "NAMEPHONE_KEY": [
        {
          "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
          "LIB_FEAT_ID": 35,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
              "LIB_FEAT_ID": 35
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
          "LIB_FEAT_ID": 17,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
              "LIB_FEAT_ID": 17
            }
          ]
        }
      ],
      "NAMEREGION_KEY": [
        {
          "FEAT_DESC": "B|SM0|ADDRESS.CITY_STD=LS FKS",
          "LIB_FEAT_ID": 54,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|ADDRESS.CITY_STD=LS FKS",
              "LIB_FEAT_ID": 54
            }
          ]
        },
        {
          "FEAT_DESC": "B|SM0|POST=89132",
          "LIB_FEAT_ID": 55,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0|POST=89132",
              "LIB_FEAT_ID": 55
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
          "LIB_FEAT_ID": 34,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
              "LIB_FEAT_ID": 34
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0|POST=89111",
          "LIB_FEAT_ID": 33,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0|POST=89111",
              "LIB_FEAT_ID": 33
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
          "LIB_FEAT_ID": 16,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
              "LIB_FEAT_ID": 16
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|POST=89111",
          "LIB_FEAT_ID": 32,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|POST=89111",
              "LIB_FEAT_ID": 32
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0|POST=89132",
          "LIB_FEAT_ID": 15,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0|POST=89132",
              "LIB_FEAT_ID": 15
            }
          ]
        }
      ],
      "NAME_KEY": [
        {
          "FEAT_DESC": "B|SM0",
          "LIB_FEAT_ID": 47,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B|SM0",
              "LIB_FEAT_ID": 47
            }
          ]
        },
        {
          "FEAT_DESC": "J|PP|SM0",
          "LIB_FEAT_ID": 38,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "J|PP|SM0",
              "LIB_FEAT_ID": 38
            }
          ]
        },
        {
          "FEAT_DESC": "PP|SM0",
          "LIB_FEAT_ID": 21,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP|SM0",
              "LIB_FEAT_ID": 21
            }
          ]
        },
        {
          "FEAT_DESC": "RPRT|SM0",
          "LIB_FEAT_ID": 5,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "RPRT|SM0",
              "LIB_FEAT_ID": 5
            }
          ]
        }
      ],
      "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
            }
          ]
        }
      ],
      "PHONE_KEY": [
        {
          "FEAT_DESC": "7029191300",
          "LIB_FEAT_ID": 8,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "7029191300",
              "LIB_FEAT_ID": 8
            }
          ]
        }
      ],
      "RECORD_TYPE": [
        {
          "FEAT_DESC": "PERSON",
          "LIB_FEAT_ID": 9,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PERSON",
              "LIB_FEAT_ID": 9
            }
          ]
        }
      ]
    }
  }
}

SZ_ENTITY_INCLUDE_RECORD_TYPES

When the SZ_ENTITY_INCLUDE_RECORD_TYPES flag is used, the resolved entity includes a RECORD_TYPES array listing the distinct record types across all constituent records.

This sample response message was generated using SZ_ENTITY_INCLUDE_RECORD_TYPES | SZ_ENTITY_DEFAULT_FLAGS :

Click to expand response JSON Click to collapse
{
  "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
      }
    ],
    "RECORD_TYPES": ["PERSON"],
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": ""
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      },
      {
        "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": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      }
    ]
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "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": 145,
      "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": 144,
      "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
        }
      ]
    }
  ]
}

Include the record types of the related entities.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_TYPES | SZ_ENTITY_DEFAULT_FLAGS :

Click to expand response JSON Click to collapse
{
  "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
      }
    ],
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": ""
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      },
      {
        "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": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      }
    ]
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "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
        }
      ],
      "RECORD_TYPES": ["PERSON"]
    },
    {
      "ENTITY_ID": 145,
      "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
        }
      ],
      "RECORD_TYPES": ["PERSON"]
    },
    {
      "ENTITY_ID": 144,
      "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
        }
      ],
      "RECORD_TYPES": ["PERSON"]
    }
  ]
}

SZ_ENTITY_INCLUDE_RECORD_DATES

When the SZ_ENTITY_INCLUDE_RECORD_DATES flag is used, each record in the RECORDS array includes FIRST_SEEN_DT and LAST_SEEN_DT timestamps indicating when the record was first and last loaded into the Senzing repository.

This sample response message was generated using SZ_ENTITY_INCLUDE_RECORD_DATES | SZ_ENTITY_DEFAULT_FLAGS :

Click to expand response JSON Click to collapse
{
  "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
      }
    ],
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": "",
        "FIRST_SEEN_DT": "2026-02-24T23:30:21Z",
        "LAST_SEEN_DT": "2026-02-24T23:30:21Z"
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL",
        "FIRST_SEEN_DT": "2026-02-24T23:30:21Z",
        "LAST_SEEN_DT": "2026-02-24T23:30:21Z"
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1003",
        "INTERNAL_ID": 3,
        "MATCH_KEY": "+NAME+DOB+EMAIL",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "SF1_PNAME_CSTAB",
        "FIRST_SEEN_DT": "2026-02-24T23:30:22Z",
        "LAST_SEEN_DT": "2026-02-24T23:30:22Z"
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1004",
        "INTERNAL_ID": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL",
        "FIRST_SEEN_DT": "2026-02-24T23:30:22Z",
        "LAST_SEEN_DT": "2026-02-24T23:30:22Z"
      }
    ]
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "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": 145,
      "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": 144,
      "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_INCLUDE_MATCH_KEY_DETAILS

When the SZ_INCLUDE_MATCH_KEY_DETAILS flag is used, each related entity includes a MATCH_KEY_DETAILS object containing CONFIRMATIONS (and optionally DENIALS) arrays. Each entry describes the specific feature comparison that contributed to or denied the relationship, including scores and score buckets.

This sample response message was generated using SZ_INCLUDE_MATCH_KEY_DETAILS | SZ_ENTITY_DEFAULT_FLAGS :

Click to expand response JSON Click to collapse
{
  "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
      }
    ],
    "RECORDS": [
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1002",
        "INTERNAL_ID": 2,
        "MATCH_KEY": "",
        "MATCH_LEVEL_CODE": "",
        "ERRULE_CODE": ""
      },
      {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "INTERNAL_ID": 1,
        "MATCH_KEY": "+NAME+DOB+PHONE",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      },
      {
        "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": 4,
        "MATCH_KEY": "+NAME+DOB+ADDRESS",
        "MATCH_LEVEL_CODE": "RESOLVED",
        "ERRULE_CODE": "CNAME_CFF_CEXCL"
      }
    ]
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 5,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB",
      "MATCH_KEY_DETAILS": {
        "CONFIRMATIONS": [
          {
            "TOKEN": "NAME",
            "FTYPE_CODE": "NAME",
            "SCORE_BEHAVIOR": "NAME",
            "SOURCE": "/SAME_NAME",
            "SCORE": 97,
            "ADDITIONAL_SCORES": {
              "GNR_FN": 97,
              "GNR_SN": 100,
              "GNR_GN": 95,
              "GNR_ON": -1,
              "GENERATION_MATCH": -1
            },
            "INBOUND_FEAT_ID": 56,
            "INBOUND_FEAT_DESC": "Robbie Smith",
            "INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
            "CANDIDATE_FEAT_ID": 1,
            "CANDIDATE_FEAT_DESC": "Robert Smith",
            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
            "SCORE_BUCKET": "CLOSE"
          },
          {
            "TOKEN": "ADDRESS",
            "FTYPE_CODE": "ADDRESS",
            "SCORE_BEHAVIOR": "FF",
            "SOURCE": "ADDRESS",
            "SCORE": 99,
            "ADDITIONAL_SCORES": {
              "FULL_SCORE": 99
            },
            "INBOUND_FEAT_ID": 1373,
            "INBOUND_FEAT_DESC": "123 Main St, Las Vegas",
            "INBOUND_FEAT_USAGE_TYPE": "MAILING",
            "CANDIDATE_FEAT_ID": 3,
            "CANDIDATE_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
            "CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
            "SCORE_BUCKET": "SAME"
          }
        ],
        "DENIALS": [
          {
            "TOKEN": "DOB",
            "FTYPE_CODE": "DOB",
            "SCORE_BEHAVIOR": "FMES",
            "SOURCE": "DOB",
            "SCORE": 59,
            "ADDITIONAL_SCORES": {
              "FULL_SCORE": 59
            },
            "INBOUND_FEAT_ID": 1372,
            "INBOUND_FEAT_DESC": "3/31/1954",
            "CANDIDATE_FEAT_ID": 2,
            "CANDIDATE_FEAT_DESC": "12/11/1978",
            "SCORE_BUCKET": "NO_CHANCE"
          }
        ]
      },
      "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": 145,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "MATCH_KEY_DETAILS": {
        "CONFIRMATIONS": [
          {
            "TOKEN": "NAME",
            "FTYPE_CODE": "NAME",
            "SCORE_BEHAVIOR": "NAME",
            "SOURCE": "/SAME_NAME",
            "SCORE": 100,
            "ADDITIONAL_SCORES": {
              "GNR_FN": 100,
              "GNR_SN": 100,
              "GNR_GN": 100,
              "GNR_ON": -1,
              "GENERATION_MATCH": -1
            },
            "INBOUND_FEAT_ID": 1,
            "INBOUND_FEAT_DESC": "Robert Smith",
            "INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
            "CANDIDATE_FEAT_ID": 1,
            "CANDIDATE_FEAT_DESC": "Robert Smith",
            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
            "SCORE_BUCKET": "SAME"
          }
        ]
      },
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0,
      "ENTITY_NAME": "Robert Smith",
      "RECORD_SUMMARY": [
        {
          "DATA_SOURCE": "WATCHLIST",
          "RECORD_COUNT": 1
        }
      ]
    },
    {
      "ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+SURNAME+ADDRESS",
      "MATCH_KEY_DETAILS": {
        "CONFIRMATIONS": [
          {
            "TOKEN": "SURNAME",
            "FTYPE_CODE": "NAME",
            "SCORE_BEHAVIOR": "NAME",
            "SOURCE": "/SUR_NAME",
            "SCORE": 49,
            "ADDITIONAL_SCORES": {
              "GNR_FN": 49,
              "GNR_SN": 100,
              "GNR_GN": 0,
              "GNR_ON": -1,
              "GENERATION_MATCH": -1
            },
            "INBOUND_FEAT_ID": 354,
            "INBOUND_FEAT_DESC": "Patricia Smith",
            "INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
            "CANDIDATE_FEAT_ID": 1,
            "CANDIDATE_FEAT_DESC": "Robert Smith",
            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
            "SCORE_BUCKET": "NO_CHANCE"
          },
          {
            "TOKEN": "ADDRESS",
            "FTYPE_CODE": "ADDRESS",
            "SCORE_BEHAVIOR": "FF",
            "SOURCE": "ADDRESS",
            "SCORE": 100,
            "ADDITIONAL_SCORES": {
              "FULL_SCORE": 100
            },
            "INBOUND_FEAT_ID": 1383,
            "INBOUND_FEAT_DESC": "1515 Adela Ln, LV, NV 89132",
            "INBOUND_FEAT_USAGE_TYPE": "HOME",
            "CANDIDATE_FEAT_ID": 46,
            "CANDIDATE_FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
            "CANDIDATE_FEAT_USAGE_TYPE": "HOME",
            "SCORE_BUCKET": "SAME"
          }
        ]
      },
      "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_FEATURE_STATS

Include feature statistics in entity responses.

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 | SZ_ENTITY_INCLUDE_ALL_FEATURES :

Click to expand response JSON Click to collapse
{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 1,
    "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,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 1,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        },
        {
          "FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
          "LIB_FEAT_ID": 46,
          "USAGE_TYPE": "HOME",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
              "LIB_FEAT_ID": 46,
              "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": 3,
          "USAGE_TYPE": "MAILING",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
              "LIB_FEAT_ID": 3,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 1,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        }
      ],
      "DOB": [
        {
          "FEAT_DESC": "11/12/1978",
          "LIB_FEAT_ID": 19,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "11/12/1978",
              "LIB_FEAT_ID": 19,
              "USED_FOR_CAND": "Y",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 1,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        },
        {
          "FEAT_DESC": "11/12/1979",
          "LIB_FEAT_ID": 45,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "11/12/1979",
              "LIB_FEAT_ID": 45,
              "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": 2,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "12/11/1978",
              "LIB_FEAT_ID": 2,
              "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": 37,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "[email protected]",
              "LIB_FEAT_ID": 37,
              "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": 44,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "B Smith",
              "LIB_FEAT_ID": 44,
              "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": 36,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Bob J Smith",
              "LIB_FEAT_ID": 36,
              "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": 18,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Bob Smith",
              "LIB_FEAT_ID": 18,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 1,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "Y"
            }
          ]
        },
        {
          "FEAT_DESC": "Robert Smith",
          "LIB_FEAT_ID": 1,
          "USAGE_TYPE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "Robert Smith",
              "LIB_FEAT_ID": 1,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 2,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        }
      ],
      "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,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 1,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        },
        {
          "FEAT_DESC": "702-919-1300",
          "LIB_FEAT_ID": 4,
          "USAGE_TYPE": "MOBILE",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "702-919-1300",
              "LIB_FEAT_ID": 4,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 1,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        }
      ],
      "RECORD_TYPE": [
        {
          "FEAT_DESC": "PERSON",
          "LIB_FEAT_ID": 9,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PERSON",
              "LIB_FEAT_ID": 9,
              "USED_FOR_CAND": "N",
              "USED_FOR_SCORING": "Y",
              "ENTITY_COUNT": 200,
              "CANDIDATE_CAP_REACHED": "N",
              "SCORING_CAP_REACHED": "N",
              "SUPPRESSED": "N"
            }
          ]
        }
      ]
    }
  }
}

If you have any questions, contact Senzing Support. Support is 100% FREE!