G2Engine Flags

Flags are optional parameters that specify what data about an entity, record, features, or relationships to retrieve. Each function’s relevant flags are detailed here. If no flag parameter is given then the default flags are used.

getRecord

These are the control flags that are applicable to getRecord().

The default composite flag is G2_RECORD_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • datasource_code: CUSTOMERS
  • record_id: 1001

G2_ENTITY_INCLUDE_RECORD_MATCHING_INFO

{
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "ENTITY_TYPE": "GENERIC",
    "ENTITY_KEY": "53C913F04DF04CA474389042F731333F92DCD3E7",
    "LAST_SEEN_DT": "2022-11-05 01:16:34.086"
}

G2_ENTITY_INCLUDE_RECORD_JSON_DATA

{
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "JSON_DATA":
    {
        "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
        "ADDR_TYPE": "MAILING",
        "AMOUNT": "100",
        "DATE": "1/2/18",
        "DATE_OF_BIRTH": "12/11/1978",
        "EMAIL_ADDRESS": "bsmith@work.com",
        "LOAD_ID": "customers.json",
        "PHONE_NUMBER": "702-919-1300",
        "PHONE_TYPE": "HOME",
        "PRIMARY_NAME_FIRST": "Robert",
        "PRIMARY_NAME_LAST": "Smith",
        "RECORD_TYPE": "PERSON",
        "STATUS": "Active",
        "DATA_SOURCE": "CUSTOMERS",
        "ENTITY_TYPE": "GENERIC",
        "DSRC_ACTION": "A",
        "RECORD_ID": "1001"
    }
}

G2_ENTITY_INCLUDE_RECORD_FORMATTED_DATA

{
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "NAME_DATA":
    [
        "PRIMARY: Smith Robert"
    ],
    "ATTRIBUTE_DATA":
    [
        "DOB: 12/11/1978",
        "RECORD_TYPE: PERSON"
    ],
    "IDENTIFIER_DATA":
    [
        "EMAIL: bsmith@work.com"
    ],
    "ADDRESS_DATA":
    [
        "MAILING: 123 Main Street, Las Vegas NV 89132"
    ],
    "PHONE_DATA":
    [
        "HOME: 702-919-1300"
    ],
    "RELATIONSHIP_DATA":
    [],
    "ENTITY_DATA":
    [],
    "OTHER_DATA":
    [
        "DATE: 1/2/18",
        "STATUS: Active",
        "AMOUNT: 100"
    ]
}

getEntity*

These are the control flags that are applicable to getEntityByRecordID(), getEntityByEntityID(), and getVirtualEntityByRecordID().

The default composite flag is G2_ENTITY_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • datasource_code: CUSTOMERS
  • record_id: 1001
  • entity_id: 1

G2_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1
    },
    "RELATED_ENTITIES":
    [
        {
            "ENTITY_ID": 5
        }
    ]
}

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1
    },
    "RELATED_ENTITIES":
    [
        {
            "ENTITY_ID": 100002
        }
    ]
}

G2_ENTITY_INCLUDE_NAME_ONLY_RELATIONS

NOTE: This flag requires enabling name-only relationships. This is not recommended as it has a sever performance impact. Please contact support@senzing.com for help.

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1
    },
    "RELATED_ENTITIES":
    []
}

G2_ENTITY_INCLUDE_DISCLOSED_RELATIONS

The parameter values (from our truthset) used to generate the response messages are:

  • datasource_code: REFERENCE
  • record_id: 2081
{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 100016
    },
    "RELATED_ENTITIES":
    [
        {
            "ENTITY_ID": 97
        }
    ]
}

G2_ENTITY_INCLUDE_ALL_FEATURES

Click to expand response JSON

G2_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES

Click to expand response JSON

G2_ENTITY_INCLUDE_ENTITY_NAME

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1,
        "ENTITY_NAME": "Robert Smith"
    }
}

G2_ENTITY_INCLUDE_RECORD_SUMMARY

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1,
        "RECORD_SUMMARY":
        [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_COUNT": 4,
                "FIRST_SEEN_DT": "2022-11-05 01:16:34.086",
                "LAST_SEEN_DT": "2022-11-05 01:16:34.167"
            }
        ],
        "LAST_SEEN_DT": "2022-11-05 01:16:34.167"
    }
}

G2_ENTITY_INCLUDE_RECORD_DATA

{
    "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"
            }
        ]
    }
}

G2_ENTITY_INCLUDE_RECORD_MATCHING_INFO

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1,
        "RECORDS":
        [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1004",
                "ENTITY_TYPE": "GENERIC",
                "INTERNAL_ID": 4,
                "ENTITY_KEY": "27EB831065949BD567D1E92681CA4ACD8C0FF1AA",
                "ENTITY_DESC": "B Smith",
                "MATCH_KEY": "",
                "MATCH_LEVEL": 0,
                "MATCH_LEVEL_CODE": "",
                "ERRULE_CODE": "",
                "LAST_SEEN_DT": "2022-11-05 01:16:34.167"
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1001",
                "ENTITY_TYPE": "GENERIC",
                "INTERNAL_ID": 1,
                "ENTITY_KEY": "53C913F04DF04CA474389042F731333F92DCD3E7",
                "ENTITY_DESC": "Robert Smith",
                "MATCH_KEY": "+NAME+DOB+PHONE+EMAIL",
                "MATCH_LEVEL": 1,
                "MATCH_LEVEL_CODE": "RESOLVED",
                "ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
                "LAST_SEEN_DT": "2022-11-05 01:16:34.086"
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1002",
                "ENTITY_TYPE": "GENERIC",
                "INTERNAL_ID": 2,
                "ENTITY_KEY": "E417012A90D71444C2E190FAF313DA88C5E663B9",
                "ENTITY_DESC": "Bob Smith",
                "MATCH_KEY": "+NAME+DOB+ADDRESS",
                "MATCH_LEVEL": 1,
                "MATCH_LEVEL_CODE": "RESOLVED",
                "ERRULE_CODE": "CNAME_CFF_CEXCL",
                "LAST_SEEN_DT": "2022-11-05 01:16:34.130"
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1003",
                "ENTITY_TYPE": "GENERIC",
                "INTERNAL_ID": 3,
                "ENTITY_KEY": "B327B02717D7515EC96319C0A0AD680FE532E27E",
                "ENTITY_DESC": "Bob J Smith",
                "MATCH_KEY": "+NAME+DOB+EMAIL",
                "MATCH_LEVEL": 1,
                "MATCH_LEVEL_CODE": "RESOLVED",
                "ERRULE_CODE": "SF1_PNAME_CSTAB",
                "LAST_SEEN_DT": "2022-11-05 01:16:34.160"
            }
        ]
    }
}

G2_ENTITY_INCLUDE_RECORD_JSON_DATA

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1,
        "RECORDS":
        [
            {
                "JSON_DATA":
                {
                    "ADDR_CITY": "Las Vegas",
                    "ADDR_LINE1": "1515 Adela Ln",
                    "ADDR_POSTAL_CODE": "89132",
                    "ADDR_STATE": "NV",
                    "ADDR_TYPE": "HOME",
                    "AMOUNT": "400",
                    "DATE": "1/5/15",
                    "DATE_OF_BIRTH": "11/12/1979",
                    "EMAIL_ADDRESS": "bsmith@work.com",
                    "LOAD_ID": "customers.json",
                    "PRIMARY_NAME_FIRST": "B",
                    "PRIMARY_NAME_LAST": "Smith",
                    "RECORD_TYPE": "PERSON",
                    "STATUS": "Inactive",
                    "DATA_SOURCE": "CUSTOMERS",
                    "ENTITY_TYPE": "GENERIC",
                    "DSRC_ACTION": "A",
                    "RECORD_ID": "1004"
                },
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1004"
            },
            {
                "JSON_DATA":
                {
                    "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
                    "ADDR_TYPE": "MAILING",
                    "AMOUNT": "100",
                    "DATE": "1/2/18",
                    "DATE_OF_BIRTH": "12/11/1978",
                    "EMAIL_ADDRESS": "bsmith@work.com",
                    "LOAD_ID": "customers.json",
                    "PHONE_NUMBER": "702-919-1300",
                    "PHONE_TYPE": "HOME",
                    "PRIMARY_NAME_FIRST": "Robert",
                    "PRIMARY_NAME_LAST": "Smith",
                    "RECORD_TYPE": "PERSON",
                    "STATUS": "Active",
                    "DATA_SOURCE": "CUSTOMERS",
                    "ENTITY_TYPE": "GENERIC",
                    "DSRC_ACTION": "A",
                    "RECORD_ID": "1001"
                },
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1001"
            },
            {
                "JSON_DATA":
                {
                    "ADDR_CITY": "Las Vegas",
                    "ADDR_LINE1": "1515 Adela Lane",
                    "ADDR_POSTAL_CODE": "89111",
                    "ADDR_STATE": "NV",
                    "ADDR_TYPE": "HOME",
                    "AMOUNT": "200",
                    "DATE": "3/10/17",
                    "DATE_OF_BIRTH": "11/12/1978",
                    "LOAD_ID": "customers.json",
                    "PHONE_NUMBER": "702-919-1300",
                    "PHONE_TYPE": "MOBILE",
                    "PRIMARY_NAME_FIRST": "Bob",
                    "PRIMARY_NAME_LAST": "Smith",
                    "RECORD_TYPE": "PERSON",
                    "STATUS": "Inactive",
                    "DATA_SOURCE": "CUSTOMERS",
                    "ENTITY_TYPE": "GENERIC",
                    "DSRC_ACTION": "A",
                    "RECORD_ID": "1002"
                },
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1002"
            },
            {
                "JSON_DATA":
                {
                    "AMOUNT": "300",
                    "DATE": "4/9/16",
                    "DATE_OF_BIRTH": "12/11/1978",
                    "EMAIL_ADDRESS": "bsmith@work.com",
                    "LOAD_ID": "customers.json",
                    "PRIMARY_NAME_FIRST": "Bob",
                    "PRIMARY_NAME_LAST": "Smith",
                    "PRIMARY_NAME_MIDDLE": "J",
                    "RECORD_TYPE": "PERSON",
                    "STATUS": "Inactive",
                    "DATA_SOURCE": "CUSTOMERS",
                    "ENTITY_TYPE": "GENERIC",
                    "DSRC_ACTION": "A",
                    "RECORD_ID": "1003"
                },
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1003"
            }
        ]
    }
}

G2_ENTITY_INCLUDE_RECORD_FORMATTED_DATA

Click to expand response JSON

G2_ENTITY_INCLUDE_RECORD_FEATURE_IDS

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1,
        "RECORDS":
        [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1004",
                "FEATURES":
                [
                    {
                        "LIB_FEAT_ID": 5
                    },
                    {
                        "LIB_FEAT_ID": 30
                    },
                    {
                        "LIB_FEAT_ID": 74,
                        "USAGE_TYPE": "PRIMARY"
                    },
                    {
                        "LIB_FEAT_ID": 75
                    },
                    {
                        "LIB_FEAT_ID": 76,
                        "USAGE_TYPE": "HOME"
                    }
                ]
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1001",
                "FEATURES":
                [
                    {
                        "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": 5
                    },
                    {
                        "LIB_FEAT_ID": 30
                    }
                ]
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1002",
                "FEATURES":
                [
                    {
                        "LIB_FEAT_ID": 4,
                        "USAGE_TYPE": "MOBILE"
                    },
                    {
                        "LIB_FEAT_ID": 30
                    },
                    {
                        "LIB_FEAT_ID": 32,
                        "USAGE_TYPE": "PRIMARY"
                    },
                    {
                        "LIB_FEAT_ID": 33
                    },
                    {
                        "LIB_FEAT_ID": 34,
                        "USAGE_TYPE": "HOME"
                    }
                ]
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1003",
                "FEATURES":
                [
                    {
                        "LIB_FEAT_ID": 2
                    },
                    {
                        "LIB_FEAT_ID": 5
                    },
                    {
                        "LIB_FEAT_ID": 30
                    },
                    {
                        "LIB_FEAT_ID": 55,
                        "USAGE_TYPE": "PRIMARY"
                    }
                ]
            }
        ]
    }
}

NOTE: The G2_ENTITY_INCLUDE_RELATED_ENTITY_NAME flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_FEATURES, G2_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, G2_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or G2_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using G2_ENTITY_INCLUDE_ALL_RELATIONS and G2_ENTITY_INCLUDE_RELATED_ENTITY_NAME:

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1
    },
    "RELATED_ENTITIES":
    [
        {
            "ENTITY_ID": 5,
            "ENTITY_NAME": "Robert E Smith Sr"
        },
        {
            "ENTITY_ID": 100002,
            "ENTITY_NAME": "Patricia Smith"
        }
    ]
}

NOTE: The G2_ENTITY_INCLUDE_RELATED_MATCHING_INFO flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, G2_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or G2_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using G2_ENTITY_INCLUDE_ALL_RELATIONS and G2_ENTITY_INCLUDE_RELATED_MATCHING_INFO:

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1
    },
    "RELATED_ENTITIES":
    [
        {
            "ENTITY_ID": 5,
            "MATCH_LEVEL": 2,
            "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
            "MATCH_KEY": "+NAME+ADDRESS-DOB",
            "ERRULE_CODE": "CNAME_CFF_DEXCL",
            "IS_DISCLOSED": 0,
            "IS_AMBIGUOUS": 0
        },
        {
            "ENTITY_ID": 100002,
            "MATCH_LEVEL": 3,
            "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
            "MATCH_KEY": "+ADDRESS+SURNAME",
            "ERRULE_CODE": "CFF_SURNAME",
            "IS_DISCLOSED": 0,
            "IS_AMBIGUOUS": 0
        }
    ]
}

NOTE: The G2_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, G2_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or G2_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using G2_ENTITY_INCLUDE_ALL_RELATIONS and G2_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY:

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 1
    },
    "RELATED_ENTITIES":
    [
        {
            "ENTITY_ID": 5,
            "RECORD_SUMMARY":
            [
                {
                    "DATA_SOURCE": "CUSTOMERS",
                    "RECORD_COUNT": 1,
                    "FIRST_SEEN_DT": "2022-12-05 01:16:34.174",
                    "LAST_SEEN_DT": "2022-12-05 01:16:34.174"
                },
                {
                    "DATA_SOURCE": "WATCHLIST",
                    "RECORD_COUNT": 1,
                    "FIRST_SEEN_DT": "2022-12-05 01:16:41.730",
                    "LAST_SEEN_DT": "2022-12-05 01:16:41.730"
                }
            ],
            "LAST_SEEN_DT": "2022-12-05 01:16:41.730"
        },
        {
            "ENTITY_ID": 100002,
            "RECORD_SUMMARY":
            [
                {
                    "DATA_SOURCE": "WATCHLIST",
                    "RECORD_COUNT": 1,
                    "FIRST_SEEN_DT": "2022-12-05 01:16:41.784",
                    "LAST_SEEN_DT": "2022-12-05 01:16:41.784"
                }
            ],
            "LAST_SEEN_DT": "2022-12-05 01:16:41.784"
        }
    ]
}

NOTE: The G2_ENTITY_INCLUDE_RELATED_RECORD_DATA flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, G2_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, G2_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or G2_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using G2_ENTITY_INCLUDE_ALL_RELATIONS and G2_ENTITY_INCLUDE_RELATED_RECORD_DATA:

{
    "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": 100002,
            "RECORDS":
            [
                {
                    "DATA_SOURCE": "WATCHLIST",
                    "RECORD_ID": "1007"
                }
            ]
        }
    ]
}

G2_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES

NOTE: The G2_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_FEATURES, G2_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, or G2_ENTITY_INCLUDE_RECORD_FEATURE_IDS.

This sample response message was generated using G2_ENTITY_INCLUDE_ALL_FEATURES and G2_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES:

Click to expand response JSON

G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS

NOTE: The G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_FEATURES, G2_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, or G2_ENTITY_INCLUDE_RECORD_FEATURE_IDS.

This sample response message was generated using G2_ENTITY_INCLUDE_ALL_FEATURES and G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS:

Click to expand response JSON

searchByAttributes

These are the control flags applicable to searchByAttributes(). searchByAttributes() uses all of the flags available to getEntity*(), plus G2_SEARCH_INCLUDE_FEATURE_SCORES and G2_SEARCH_INCLUDE_STATS.

The default composite flag is G2_SEARCH_BY_ATTRIBUTES_ALL.

The recommended composite flags are G2_SEARCH_BY_ATTRIBUTES_ALL, G2_SEARCH_BY_ATTRIBUTES_STRONG, G2_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL, and G2_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG.

The parameter values (from our truthset) used to generate the response messages are:

  • data_as_json: {"NAME_FULL":"BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"}

G2_SEARCH_BY_ATTRIBUTES_ALL

Click to expand response JSON

G2_SEARCH_BY_ATTRIBUTES_STRONG

Click to expand response JSON

G2_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL

Click to expand response JSON

G2_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG

Click to expand response JSON

G2_SEARCH_INCLUDE_FEATURE_SCORES

Click to expand response JSON

G2_SEARCH_INCLUDE_STATS

Click to expand response JSON

findPath*

These are the control flags applicable to findPathByEntityID(), findPathByRecordID(), findPathExcludingByEntityID(), findPathExcludingByRecordID(), findPathIncludingSourceByEntityID(), and findPathIncludingSouceByRecordID().

findPath*() methods use all of the flags available to getEntity*().

In addition, G2_FIND_PATH_PREFER_EXCLUDE is available to findPathExcludingByEntityID() and findPathExcludingByRecordID().

The default composite flag is G2_FIND_PATH_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • datasource_code_1: CUSTOMERS
  • record_id_1: 1001
  • entity_id_1: 1
  • datasource_code_2: WATCHLIST
  • record_id_2: 1007
  • entity_id_2: 100002
  • excluded_entities = {"ENTITIES": [{"ENTITY_ID": "5"}]}

G2_FIND_PATH_PREFER_EXCLUDE

NOTE: The G2_FIND_PATH_PREFER_EXCLUDE flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_FEATURES, G2_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, or G2_ENTITY_INCLUDE_RECORD_FEATURE_IDS.

G2_FIND_PATH_PREFER_EXCLUDE sets the exclusion to preferred instead of strict exclusion. Preferred exclusion means that if an excluded entity is the only one in the path, it will be used, but strict will never include excluded entities in the path.

This sample response message was generated using G2_FIND_PATH_DEFAULT_FLAGS and G2_FIND_PATH_PREFER_EXCLUDE:

{
    "ENTITY_PATHS":
    [
        {
            "START_ENTITY_ID": 1,
            "END_ENTITY_ID": 100002,
            "ENTITIES":
            [
                1,
                100002
            ]
        }
    ],
    "ENTITIES":
    [
        {
            "RESOLVED_ENTITY":
            {
                "ENTITY_ID": 1,
                "ENTITY_NAME": "Robert Smith",
                "RECORD_SUMMARY":
                [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 4,
                        "FIRST_SEEN_DT": "2022-12-05 01:16:34.086",
                        "LAST_SEEN_DT": "2022-12-05 01:16:34.167"
                    }
                ],
                "LAST_SEEN_DT": "2022-12-05 01:16:34.167"
            },
            "RELATED_ENTITIES":
            [
                {
                    "ENTITY_ID": 5,
                    "MATCH_LEVEL": 2,
                    "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
                    "MATCH_KEY": "+NAME+ADDRESS-DOB",
                    "ERRULE_CODE": "CNAME_CFF_DEXCL",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                },
                {
                    "ENTITY_ID": 100002,
                    "MATCH_LEVEL": 3,
                    "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
                    "MATCH_KEY": "+ADDRESS+SURNAME",
                    "ERRULE_CODE": "CFF_SURNAME",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                }
            ]
        },
        {
            "RESOLVED_ENTITY":
            {
                "ENTITY_ID": 100002,
                "ENTITY_NAME": "Patricia Smith",
                "RECORD_SUMMARY":
                [
                    {
                        "DATA_SOURCE": "WATCHLIST",
                        "RECORD_COUNT": 1,
                        "FIRST_SEEN_DT": "2022-12-05 01:16:41.784",
                        "LAST_SEEN_DT": "2022-12-05 01:16:41.784"
                    }
                ],
                "LAST_SEEN_DT": "2022-12-05 01:16:41.784"
            },
            "RELATED_ENTITIES":
            [
                {
                    "ENTITY_ID": 1,
                    "MATCH_LEVEL": 3,
                    "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
                    "MATCH_KEY": "+ADDRESS+SURNAME",
                    "ERRULE_CODE": "CFF_SURNAME",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                }
            ]
        }
    ]
}

findNetwork*

These are the control flags applicable to findNetworkByEntityID() and findNetworkByRecordID().

findNetwork*() use all of the flags available to getEntity*().

The default composite flag is G2_FIND_PATH_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • entity_list_as_json: = {"ENTITIES": [{"ENTITY_ID": "5"}]}
  • record_list_as_json: = {"RECORDS": [{"RECORD_ID": "1001", "DATA_SOURCE": "CUSTOMERS"}]}
  • max_degree = 10
  • buildout_degree = 10
  • max_entities = 10

This sample response message was generated using the default G2_FIND_PATH_DEFAULT_FLAGS flag:

{
    "ENTITY_PATHS":
    [
        {
            "START_ENTITY_ID": 5,
            "END_ENTITY_ID": 100002,
            "ENTITIES":
            [
                5,
                1,
                100002
            ]
        }
    ],
    "ENTITIES":
    [
        {
            "RESOLVED_ENTITY":
            {
                "ENTITY_ID": 1,
                "ENTITY_NAME": "Robert Smith",
                "RECORD_SUMMARY":
                [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 4,
                        "FIRST_SEEN_DT": "2022-12-05 01:16:34.086",
                        "LAST_SEEN_DT": "2022-12-05 01:16:34.167"
                    }
                ],
                "LAST_SEEN_DT": "2022-12-05 01:16:34.167"
            },
            "RELATED_ENTITIES":
            [
                {
                    "ENTITY_ID": 5,
                    "MATCH_LEVEL": 2,
                    "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
                    "MATCH_KEY": "+NAME+ADDRESS-DOB",
                    "ERRULE_CODE": "CNAME_CFF_DEXCL",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                },
                {
                    "ENTITY_ID": 100002,
                    "MATCH_LEVEL": 3,
                    "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
                    "MATCH_KEY": "+ADDRESS+SURNAME",
                    "ERRULE_CODE": "CFF_SURNAME",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                }
            ]
        },
        {
            "RESOLVED_ENTITY":
            {
                "ENTITY_ID": 5,
                "ENTITY_NAME": "Robert E Smith Sr",
                "RECORD_SUMMARY":
                [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 1,
                        "FIRST_SEEN_DT": "2022-12-05 01:16:34.174",
                        "LAST_SEEN_DT": "2022-12-05 01:16:34.174"
                    },
                    {
                        "DATA_SOURCE": "WATCHLIST",
                        "RECORD_COUNT": 1,
                        "FIRST_SEEN_DT": "2022-12-05 01:16:41.730",
                        "LAST_SEEN_DT": "2022-12-05 01:16:41.730"
                    }
                ],
                "LAST_SEEN_DT": "2022-12-05 01:16:41.730"
            },
            "RELATED_ENTITIES":
            [
                {
                    "ENTITY_ID": 1,
                    "MATCH_LEVEL": 2,
                    "MATCH_LEVEL_CODE": "POSSIBLY_SAME",
                    "MATCH_KEY": "+NAME+ADDRESS-DOB",
                    "ERRULE_CODE": "CNAME_CFF_DEXCL",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                }
            ]
        },
        {
            "RESOLVED_ENTITY":
            {
                "ENTITY_ID": 100002,
                "ENTITY_NAME": "Patricia Smith",
                "RECORD_SUMMARY":
                [
                    {
                        "DATA_SOURCE": "WATCHLIST",
                        "RECORD_COUNT": 1,
                        "FIRST_SEEN_DT": "2022-12-05 01:16:41.784",
                        "LAST_SEEN_DT": "2022-12-05 01:16:41.784"
                    }
                ],
                "LAST_SEEN_DT": "2022-12-05 01:16:41.784"
            },
            "RELATED_ENTITIES":
            [
                {
                    "ENTITY_ID": 1,
                    "MATCH_LEVEL": 3,
                    "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
                    "MATCH_KEY": "+ADDRESS+SURNAME",
                    "ERRULE_CODE": "CFF_SURNAME",
                    "IS_DISCLOSED": 0,
                    "IS_AMBIGUOUS": 0
                }
            ]
        }
    ]
}

why*

These are the control flags applicable to whyEntities(), whyRecords(), whyEntityByEntityID(), and whyEntityByRecordID().

why*() use all of the flags available to getEntity*(), plus G2_INCLUDE_FEATURE_SCORES.

The default composite flag is G2_WHY_ENTITY_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • datasource_code_1: CUSTOMERS
  • record_id_1: 1001
  • entity_id_1: 1
  • datasource_code_2: WATCHLIST
  • record_id_2: 1007
  • entity_id_2: 100002

This sample response message was generated using G2_WHY_ENTITY_DEFAULT_FLAGS and G2_INCLUDE_FEATURE_SCORES:

Click to expand response JSON

howEntityByEntityID

These are the control flags that are applicable to howEntityByEntityID().

howEntityByEntityID() uses all of the flags available to getEntity*(), plus G2_INCLUDE_FEATURE_SCORES.

The default composite flag is G2_HOW_ENTITY_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • entity_id: 1

The recommended composite flag is G2_HOW_ENTITY_DEFAULT_FLAGS.

Click to expand response JSON

getVirtualEntityByRecordID

These are the control flags that are applicable to getVirtualEntityByRecordID().

getVirtualEntityByRecordID() uses all of the flags available to getEntity*(), plus G2_HOW_ENTITY_DEFAULT_FLAGS.

The default composite flag is G2_HOW_ENTITY_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

  • record_list: {"RECORDS": [{"DATA_SOURCE": "CUSTOMERS","RECORD_ID": "1001"},{"DATA_SOURCE": "CUSTOMERS","RECORD_ID": "1022"}]}
Click to expand response JSON

exportJSONEntityReport

These are the control flags that are applicable to exportJSONEntityReport():

  • G2_EXPORT_INCLUDE_RESOLVED
  • G2_EXPORT_INCLUDE_POSSIBLY_SAME
  • G2_EXPORT_INCLUDE_POSSIBLY_RELATED
  • G2_EXPORT_INCLUDE_NAME_ONLY
  • G2_EXPORT_INCLUDE_DISCLOSED
  • G2_EXPORT_INCLUDE_SINGLETONS
  • G2_EXPORT_INCLUDE_ALL_ENTITIES
  • G2_EXPORT_INCLUDE_ALL_RELATIONSHIPS
  • G2_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS
  • G2_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS
  • G2_ENTITY_INCLUDE_NAME_ONLY_RELATIONS
  • G2_ENTITY_INCLUDE_DISCLOSED_RELATIONS
  • G2_ENTITY_INCLUDE_ALL_FEATURES
  • G2_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
  • G2_ENTITY_INCLUDE_ENTITY_NAME
  • G2_ENTITY_INCLUDE_RECORD_SUMMARY
  • G2_ENTITY_INCLUDE_RECORD_DATA
  • G2_ENTITY_INCLUDE_RECORD_MATCHING_INFO
  • G2_ENTITY_INCLUDE_RECORD_JSON_DATA
  • G2_ENTITY_INCLUDE_RECORD_FORMATTED_DATA
  • G2_ENTITY_INCLUDE_RECORD_FEATURE_IDS
  • G2_ENTITY_INCLUDE_RELATED_ENTITY_NAME
  • G2_ENTITY_INCLUDE_RELATED_MATCHING_INFO
  • G2_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY
  • G2_ENTITY_INCLUDE_RELATED_RECORD_DATA
  • G2_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES
  • G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS

exportCSVEntityReport

These are the control flags that are applicable to exportCSVEntityReport():

  • G2_EXPORT_INCLUDE_RESOLVED
  • G2_EXPORT_INCLUDE_POSSIBLY_SAME
  • G2_EXPORT_INCLUDE_POSSIBLY_RELATED
  • G2_EXPORT_INCLUDE_NAME_ONLY
  • G2_EXPORT_INCLUDE_DISCLOSED
  • G2_EXPORT_INCLUDE_SINGLETONS