find_network* Flags

find_network_by_entity_id, find_network_by_record_id

These are the control flags applicable to:

  • C/C++: Sz_findNetworkByEntityID, Sz_findNetworkByRecordID
  • C#: FindNetwork
  • Java: findNetwork
  • Python: find_network_by_entity_id, find_network_by_record_id
  • sz_command: find_network_by_entity_id, find_network_by_record_id

find_network_by_entity_id, find_network_by_record_id methods use all the get_entity*() flags , plus SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO .

The default composite flag is SZ_FIND_NETWORK_DEFAULT_FLAGS .

SZ_FIND_NETWORK_DEFAULT_FLAGS

The output of SZ_FIND_NETWORK_DEFAULT_FLAGS is a composite of:

Click to expand response JSON Click to collapse
{
  "ENTITY_PATHS": [
    {
      "START_ENTITY_ID": 1,
      "END_ENTITY_ID": 144,
      "ENTITIES": [1, 144]
    }
  ],
  "ENTITY_NETWORK_LINKS": [
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 5,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 145,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 5,
      "MAX_ENTITY_ID": 145,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 28,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 29,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+DOB+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 30,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME-DOB",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS (Ambiguous)",
      "ERRULE_CODE": "CNAME_CFF",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 1
    },
    {
      "MIN_ENTITY_ID": 28,
      "MAX_ENTITY_ID": 29,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME-DOB",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 28,
      "MAX_ENTITY_ID": 30,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+DOB+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 28,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS (Ambiguous)",
      "ERRULE_CODE": "CNAME_CFF",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 1
    },
    {
      "MIN_ENTITY_ID": 29,
      "MAX_ENTITY_ID": 30,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB-PASSPORT",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 29,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 29,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 30,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 30,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    }
  ],
  "ENTITIES": [
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 1,
        "ENTITY_NAME": "Robert Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 4
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 5,
        "ENTITY_NAME": "Robert E Smith Sr",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 1
          },
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 27,
        "ENTITY_NAME": "John Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 28,
        "ENTITY_NAME": "John Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 29,
        "ENTITY_NAME": "Patrick Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 2
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 30,
        "ENTITY_NAME": "Patricia Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 2
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 144,
        "ENTITY_NAME": "Patricia Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 145,
        "ENTITY_NAME": "Robert Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 154,
        "ENTITY_NAME": "John Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 2
          }
        ]
      }
    }
  ]
}

SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO

Include matching info on entity network links for find-network functionality.

This sample response message was generated using SZ_FIND_NETWORK_INCLUDE_MATCHING_INFO | SZ_ENTITY_INCLUDE_RECORD_SUMMARY :

Click to expand response JSON Click to collapse
{
  "ENTITY_PATHS": [
    {
      "START_ENTITY_ID": 1,
      "END_ENTITY_ID": 144,
      "ENTITIES": [1, 144]
    }
  ],
  "ENTITY_NETWORK_LINKS": [
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 5,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 145,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 5,
      "MAX_ENTITY_ID": 145,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 28,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 29,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+DOB+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 30,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME-DOB",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 27,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS (Ambiguous)",
      "ERRULE_CODE": "CNAME_CFF",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 1
    },
    {
      "MIN_ENTITY_ID": 28,
      "MAX_ENTITY_ID": 29,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME-DOB",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 28,
      "MAX_ENTITY_ID": 30,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+DOB+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 28,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS (Ambiguous)",
      "ERRULE_CODE": "CNAME_CFF",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 1
    },
    {
      "MIN_ENTITY_ID": 29,
      "MAX_ENTITY_ID": 30,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME+ADDRESS-DOB-PASSPORT",
      "ERRULE_CODE": "CNAME_CFF_DEXCL",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 29,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 29,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 30,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
      "MATCH_KEY": "+NAME",
      "ERRULE_CODE": "SNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    },
    {
      "MIN_ENTITY_ID": 30,
      "MAX_ENTITY_ID": 154,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    }
  ],
  "ENTITIES": [
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 1,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 4
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 5,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 1
          },
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 27,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 28,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 29,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 2
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 30,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 2
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 144,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 145,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 154,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 2
          }
        ]
      }
    }
  ]
}

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