NAV Navbar
Python Java C G2Command shell

Interpreting Entity API Response Messages

Once you start incorporating the insights derived from Entity Resolution into your own applications via the APIs, interpreting the response messages might be a little unwieldy at first! Using the sample data supplied we'll take a look at how to interpret the JSON response messages

Load the Sample Data

The following commands assume default deployment location and you don't have useful data you'd like to maintain already loaded; the commands will purge your currently loaded data. Review the Backup & Restore SQLite Repository article to preserve existing loaded data.

If you already have Senzing API deployed and need to reload the sample data to work with, it can be loaded in one of 2 ways:

$ cd /opt/senzing/g2/python $ . ../setupEnv $ python G2Loader.py -P
$ cd /opt/senzing/g2/python $ . ../setupEnv $ python G2Loader.py -P -p demo/sample/project.csv

Once loading is complete you'll see output similar to:

*************** Purging G2 database ... -------------------------------------------------- Data source: PEOPLE, Format: CSV Loading /opt/senzing/g2/python/demo/sample/sample_person.csv ... dropping to single thread due to small file size Finishing up ... Statistics: good records .......... 4 bad records ........... 0 incomplete records .... 0 elapsed time .......... 0.1 minutes records per second .... 0 -------------------------------------------------- Data source: COMPANIES, Format: CSV Loading /opt/senzing/g2/python/demo/sample/sample_company.csv ... dropping to single thread due to small file size Finishing up ... Statistics: good records .......... 4 bad records ........... 0 incomplete records .... 0 elapsed time .......... 0.1 minutes records per second .... 0 Process completed sucessfully in 0.2 minutes

Search and Return an Entity

To quickly work with the G2 APIs we will use the G2Command utility. G2Command is a command line interpreter for interfacing with the APIs, although not fully supported we endeavor to keep it up to date and add enhancements.

Start G2Command:

python > pwd /opt/senzing/g2/python python > python G2Command.py Initializing engine... Welcome to the G2 shell. Type help or ? to list commands. (g2) help Documented commands (type help ): ======================================== addRecord getActiveConfigID process anonymize getAuditReport processFile anonymizeFile getEntityByEntityID processFileWithResponse closeExport getEntityByRecordID processWithResponse closeSession getRecord purgeRepository deleteRecord getRepositoryLastModifiedTime quit exit getSummaryData replaceRecord exportCSVEntityReport getUsedMatchKeys searchByAttributes exportConfig getUsedPrinciples stats exportJSONEntityReport help version exportTokenLibrary license fetchNext openSession Miscellaneous help topics: ========================== KnowledgeCenter MatchLevels Support Shell Arguments (g2)

We can now use the searchByAttributes API to search for a data source record contained within the sample_person.json file loaded above.

(g2) searchByAttributes '{"DATE_OF_BIRTH": "1/2/1981", "EMAIL_ADDRESS": "bob@jonesfamily.com"}' {"SEARCH_RESPONSE":{"RESOLVED_ENTITIES":[{"LENS_ID":1,"ENTITY_ID":1,"MATCH_LEVEL":1,"MATCH_KEY":"+DOB+EMAIL","MATCH_SCORE":"1","ERRULE_CODE":"SF1_PNAME_CSTAB","REF_SCORE":9,"FEATURES":{"ADDRESS":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4,"UTYPE_CODE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4},{"FEAT_DESC":"111 1ST ST LAS VEGAS NV 89222","LIB_FEAT_ID":25}]},{"FEAT_DESC":"PO BOX 111 LAS VEGAS NV 89111","LIB_FEAT_ID":5,"UTYPE_CODE":"MAIL","FEAT_DESC_VALUES":[{"FEAT_DESC":"PO BOX 111 LAS VEGAS NV 89111","LIB_FEAT_ID":5}]}],"DOB":[{"FEAT_DESC":"1981-01-02","LIB_FEAT_ID":2,"FEAT_DESC_VALUES":[{"FEAT_DESC":"1981-01-02","LIB_FEAT_ID":2},{"FEAT_DESC":"1981-02-01","LIB_FEAT_ID":24}]}],"DRLIC":[{"FEAT_DESC":"DL11111 NV","LIB_FEAT_ID":9,"FEAT_DESC_VALUES":[{"FEAT_DESC":"DL11111 NV","LIB_FEAT_ID":9}]}],"EMAIL":[{"FEAT_DESC":"BOB@JONESFAMILY.COM","LIB_FEAT_ID":12,"FEAT_DESC_VALUES":[{"FEAT_DESC":"BOB@JONESFAMILY.COM","LIB_FEAT_ID":12}]}],"GENDER":[{"FEAT_DESC":"M","LIB_FEAT_ID":3,"FEAT_DESC_VALUES":[{"FEAT_DESC":"M","LIB_FEAT_ID":3}]}],"LOGIN_ID":[{"FEAT_DESC":"@BOBJONES27","LIB_FEAT_ID":11,"FEAT_DESC_VALUES":[{"FEAT_DESC":"@BOBJONES27","LIB_FEAT_ID":11}]}],"NAME":[{"FEAT_DESC":"ROBERT M JONES","LIB_FEAT_ID":1,"UTYPE_CODE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"ROBERT M JONES","LIB_FEAT_ID":1},{"FEAT_DESC":"BOBBY JONES","LIB_FEAT_ID":23}]}],"PASSPORT":[{"FEAT_DESC":"PP11111 US","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PP11111 US","LIB_FEAT_ID":10}]}],"PHONE":[{"FEAT_DESC":"702-222-2222","LIB_FEAT_ID":6,"UTYPE_CODE":"CELL","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-222-2222","LIB_FEAT_ID":6}]},{"FEAT_DESC":"800-201-2001","LIB_FEAT_ID":7,"UTYPE_CODE":"WORK","FEAT_DESC_VALUES":[{"FEAT_DESC":"800-201-2001","LIB_FEAT_ID":7}]}],"SSN":[{"FEAT_DESC":"311-11-1111","LIB_FEAT_ID":8,"FEAT_DESC_VALUES":[{"FEAT_DESC":"311-11-1111","LIB_FEAT_ID":8}]}]},"MATCH_SCORES":{"DOB":[{"INBOUND_FEAT":"1981-01-02","CANDIDATE_FEAT":"1981-01-02","FULL_SCORE":100}],"EMAIL":[{"INBOUND_FEAT":"BOB@JONESFAMILY.COM","CANDIDATE_FEAT":"BOB@JONESFAMILY.COM","FULL_SCORE":100}]},"RECORDS":[{"JSON_DATA":{"CELL_PHONE_NUMBER":"702-222-2222","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"1/2/1981","DRIVERS_LICENSE_NUMBER":"DL11111","DRIVERS_LICENSE_STATE":"NV","DSRC_ACTION":"A","EMAIL_ADDRESS":"bob@jonesfamily.com","ENTITY_TYPE":"PEOPLE","GENDER":"M","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"US","HOME_ADDR_LINE1":"111 First St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89111","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"Las Vegas","MAIL_ADDR_COUNTRY":"US","MAIL_ADDR_LINE1":"PO Box 111","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"89111","MAIL_ADDR_STATE":"NV","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"US","PASSPORT_NUMBER":"PP11111","PRIMARY_NAME_FIRST":"Robert","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"M","PRIMARY_NAME_PREFIX":"Mr","PRIMARY_NAME_SUFFIX":"Jr","RECORD_ID":"1001","SOCIAL_HANDLE":"@bobjones27","SOCIAL_NETWORK":"twitter","SSN_NUMBER":"311-11-1111","WORK_PHONE_NUMBER":"800-201-2001","ENTITY_KEY":"385E9EEC1A7C66575F0184A1371D564F2B8BD673","ENTITY_NAME":"Mr Robert M Jones Jr","MATCH_KEY":"","MATCH_SCORE":"","ERRULE_CODE":"","REF_SCORE":0,"MATCH_LEVEL":0},"NAME_DATA":["PRIMARY: Jones Robert M Mr Jr"],"ATTRIBUTE_DATA":["DOB: 1/2/1981","GENDER: M"],"IDENTIFIER_DATA":["DRLIC: DL11111 NV","EMAIL: bob@jonesfamily.com","LOGIN_ID: twitter @bobjones27","PASSPORT: PP11111 US","SSN: 311-11-1111"],"ADDRESS_DATA":["HOME: 111 First St Las Vegas NV 89111 US","MAIL: PO Box 111 Las Vegas NV 89111 US"],"PHONE_DATA":["CELL: 702-222-2222","WORK: 800-201-2001"],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]},{"JSON_DATA":{"CELL_PHONE_NUMBER":"","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"2/1/1981","DRIVERS_LICENSE_NUMBER":"","DRIVERS_LICENSE_STATE":"","DSRC_ACTION":"A","EMAIL_ADDRESS":"","ENTITY_TYPE":"PEOPLE","GENDER":"M","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"","HOME_ADDR_LINE1":"111 1st St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89222","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"","MAIL_ADDR_COUNTRY":"","MAIL_ADDR_LINE1":"","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"","MAIL_ADDR_STATE":"","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"","PASSPORT_NUMBER":"","PRIMARY_NAME_FIRST":"Bobby","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"","PRIMARY_NAME_PREFIX":"","PRIMARY_NAME_SUFFIX":"","RECORD_ID":"1002","SOCIAL_HANDLE":"","SOCIAL_NETWORK":"","SSN_NUMBER":"","WORK_PHONE_NUMBER":"","ENTITY_KEY":"FF1C69034FA4B3D82193A42843937478EBA2CB61","ENTITY_NAME":"Bobby Jones","MATCH_KEY":"+NAME+DOB+GENDER+ADDRESS","MATCH_SCORE":"14","ERRULE_CODE":"CNAME_CFF_CEXCL","REF_SCORE":8,"MATCH_LEVEL":1},"NAME_DATA":["PRIMARY: Jones Bobby"],"ATTRIBUTE_DATA":["DOB: 2/1/1981","GENDER: M"],"IDENTIFIER_DATA":[],"ADDRESS_DATA":["HOME: 111 1st St Las Vegas NV 89222"],"PHONE_DATA":[],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]}]}]}} (g2)

The searchByAttributes API located an entity matching the attributes for the date of birth and email address supplied. This is the same search response message any application you built would receive issuing the same API call.

Parsing a Response Message

To make the response message easier to view and interpret you can use a JSON parser or processor that pretty prints JSON. A powerful command like processor is jq, it isn't always installed on Linux by default yet is typically in the distribution repositories and straightforward to install using your distribution package manager. For example:

Note: Be careful using online JSON parsers on your sensitive data, you don't want to be sharing it in such a fashion!

To pretty print the response message using jq, copy the entirety of the response message and paste it into a jq command and surround the response message with single quotes.

python > jq . <<< '{"SEARCH_RESPONSE":{"RESOLVED_ENTITIES":[{"LENS_ID":1,"ENTITY_ID":1,"MATCH_LEVEL":1,"MATCH_KEY":"+DOB+EMAIL","MATCH_SCORE":"1","ERRULE_CODE":"SF1_PNAME_CSTAB","REF_SCORE":9,"FEATURES":{"ADDRESS":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4,"UTYPE_CODE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4},{"FEAT_DESC":"111 1ST ST LAS VEGAS NV 89222","LIB_FEAT_ID":25}]},{"FEAT_DESC":"PO BOX 111 LAS VEGAS NV 89111","LIB_FEAT_ID":5,"UTYPE_CODE":"MAIL","FEAT_DESC_VALUES":[{"FEAT_DESC":"PO BOX 111 LAS VEGAS NV 89111","LIB_FEAT_ID":5}]}],"DOB":[{"FEAT_DESC":"1981-01-02","LIB_FEAT_ID":2,"FEAT_DESC_VALUES":[{"FEAT_DESC":"1981-01-02","LIB_FEAT_ID":2},{"FEAT_DESC":"1981-02-01","LIB_FEAT_ID":24}]}],"DRLIC":[{"FEAT_DESC":"DL11111 NV","LIB_FEAT_ID":9,"FEAT_DESC_VALUES":[{"FEAT_DESC":"DL11111 NV","LIB_FEAT_ID":9}]}],"EMAIL":[{"FEAT_DESC":"BOB@JONESFAMILY.COM","LIB_FEAT_ID":12,"FEAT_DESC_VALUES":[{"FEAT_DESC":"BOB@JONESFAMILY.COM","LIB_FEAT_ID":12}]}],"GENDER":[{"FEAT_DESC":"M","LIB_FEAT_ID":3,"FEAT_DESC_VALUES":[{"FEAT_DESC":"M","LIB_FEAT_ID":3}]}],"LOGIN_ID":[{"FEAT_DESC":"@BOBJONES27","LIB_FEAT_ID":11,"FEAT_DESC_VALUES":[{"FEAT_DESC":"@BOBJONES27","LIB_FEAT_ID":11}]}],"NAME":[{"FEAT_DESC":"ROBERT M JONES","LIB_FEAT_ID":1,"UTYPE_CODE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"ROBERT M JONES","LIB_FEAT_ID":1},{"FEAT_DESC":"BOBBY JONES","LIB_FEAT_ID":23}]}],"PASSPORT":[{"FEAT_DESC":"PP11111 US","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PP11111 US","LIB_FEAT_ID":10}]}],"PHONE":[{"FEAT_DESC":"702-222-2222","LIB_FEAT_ID":6,"UTYPE_CODE":"CELL","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-222-2222","LIB_FEAT_ID":6}]},{"FEAT_DESC":"800-201-2001","LIB_FEAT_ID":7,"UTYPE_CODE":"WORK","FEAT_DESC_VALUES":[{"FEAT_DESC":"800-201-2001","LIB_FEAT_ID":7}]}],"SSN":[{"FEAT_DESC":"311-11-1111","LIB_FEAT_ID":8,"FEAT_DESC_VALUES":[{"FEAT_DESC":"311-11-1111","LIB_FEAT_ID":8}]}]},"MATCH_SCORES":{"DOB":[{"INBOUND_FEAT":"1981-01-02","CANDIDATE_FEAT":"1981-01-02","FULL_SCORE":100}],"EMAIL":[{"INBOUND_FEAT":"BOB@JONESFAMILY.COM","CANDIDATE_FEAT":"BOB@JONESFAMILY.COM","FULL_SCORE":100}]},"RECORDS":[{"JSON_DATA":{"CELL_PHONE_NUMBER":"702-222-2222","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"1/2/1981","DRIVERS_LICENSE_NUMBER":"DL11111","DRIVERS_LICENSE_STATE":"NV","DSRC_ACTION":"A","EMAIL_ADDRESS":"bob@jonesfamily.com","ENTITY_TYPE":"PEOPLE","GENDER":"M","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"US","HOME_ADDR_LINE1":"111 First St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89111","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"Las Vegas","MAIL_ADDR_COUNTRY":"US","MAIL_ADDR_LINE1":"PO Box 111","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"89111","MAIL_ADDR_STATE":"NV","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"US","PASSPORT_NUMBER":"PP11111","PRIMARY_NAME_FIRST":"Robert","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"M","PRIMARY_NAME_PREFIX":"Mr","PRIMARY_NAME_SUFFIX":"Jr","RECORD_ID":"1001","SOCIAL_HANDLE":"@bobjones27","SOCIAL_NETWORK":"twitter","SSN_NUMBER":"311-11-1111","WORK_PHONE_NUMBER":"800-201-2001","ENTITY_KEY":"385E9EEC1A7C66575F0184A1371D564F2B8BD673","ENTITY_NAME":"Mr Robert M Jones Jr","MATCH_KEY":"","MATCH_SCORE":"","ERRULE_CODE":"","REF_SCORE":0,"MATCH_LEVEL":0},"NAME_DATA":["PRIMARY: Jones Robert M Mr Jr"],"ATTRIBUTE_DATA":["DOB: 1/2/1981","GENDER: M"],"IDENTIFIER_DATA":["DRLIC: DL11111 NV","EMAIL: bob@jonesfamily.com","LOGIN_ID: twitter @bobjones27","PASSPORT: PP11111 US","SSN: 311-11-1111"],"ADDRESS_DATA":["HOME: 111 First St Las Vegas NV 89111 US","MAIL: PO Box 111 Las Vegas NV 89111 US"],"PHONE_DATA":["CELL: 702-222-2222","WORK: 800-201-2001"],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]},{"JSON_DATA":{"CELL_PHONE_NUMBER":"","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"2/1/1981","DRIVERS_LICENSE_NUMBER":"","DRIVERS_LICENSE_STATE":"","DSRC_ACTION":"A","EMAIL_ADDRESS":"","ENTITY_TYPE":"PEOPLE","GENDER":"M","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"","HOME_ADDR_LINE1":"111 1st St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89222","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"","MAIL_ADDR_COUNTRY":"","MAIL_ADDR_LINE1":"","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"","MAIL_ADDR_STATE":"","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"","PASSPORT_NUMBER":"","PRIMARY_NAME_FIRST":"Bobby","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"","PRIMARY_NAME_PREFIX":"","PRIMARY_NAME_SUFFIX":"","RECORD_ID":"1002","SOCIAL_HANDLE":"","SOCIAL_NETWORK":"","SSN_NUMBER":"","WORK_PHONE_NUMBER":"","ENTITY_KEY":"FF1C69034FA4B3D82193A42843937478EBA2CB61","ENTITY_NAME":"Bobby Jones","MATCH_KEY":"+NAME+DOB+GENDER+ADDRESS","MATCH_SCORE":"14","ERRULE_CODE":"CNAME_CFF_CEXCL","REF_SCORE":8,"MATCH_LEVEL":1},"NAME_DATA":["PRIMARY: Jones Bobby"],"ATTRIBUTE_DATA":["DOB: 2/1/1981","GENDER: M"],"IDENTIFIER_DATA":[],"ADDRESS_DATA":["HOME: 111 1st St Las Vegas NV 89222"],"PHONE_DATA":[],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]}]}]}}'

jq will pretty print the response message directly to the terminal. Redirect the output to a file or other location to capture it if you choose. For example, jq will output the above as follows:

{ "SEARCH_RESPONSE": { "RESOLVED_ENTITIES": [ { "LENS_ID": 1, "ENTITY_ID": 1, "MATCH_LEVEL": 1, "MATCH_KEY": "+DOB+EMAIL", "MATCH_SCORE": "1", "ERRULE_CODE": "SF1_PNAME_CSTAB", "REF_SCORE": 9, "FEATURES": { "ADDRESS": [ { "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111", "LIB_FEAT_ID": 4, "UTYPE_CODE": "HOME", "FEAT_DESC_VALUES": [ { "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111", "LIB_FEAT_ID": 4 }, { "FEAT_DESC": "111 1ST ST LAS VEGAS NV 89222", "LIB_FEAT_ID": 25 } ] },

Example Search Response Message

Example response (jq):

{
  "SEARCH_RESPONSE": {
    "RESOLVED_ENTITIES": [
      {
        "LENS_ID": 1,
        "ENTITY_ID": 1,
        "MATCH_LEVEL": 1,
        "MATCH_KEY": "+DOB+EMAIL",
        "MATCH_SCORE": "1",
        "ERRULE_CODE": "SF1_PNAME_CSTAB",
        "REF_SCORE": 9,
        "FEATURES": {
          "ADDRESS": [
            {
              "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111",
              "LIB_FEAT_ID": 4,
              "UTYPE_CODE": "HOME",
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111",
                  "LIB_FEAT_ID": 4
                },
                {
                  "FEAT_DESC": "111 1ST ST LAS VEGAS NV 89222",
                  "LIB_FEAT_ID": 25
                }
              ]
            },
            {
              "FEAT_DESC": "PO BOX 111 LAS VEGAS NV 89111",
              "LIB_FEAT_ID": 5,
              "UTYPE_CODE": "MAIL",
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "PO BOX 111 LAS VEGAS NV 89111",
                  "LIB_FEAT_ID": 5
                }
              ]
            }
          ],
          "DOB": [
            {
              "FEAT_DESC": "1981-01-02",
              "LIB_FEAT_ID": 2,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "1981-01-02",
                  "LIB_FEAT_ID": 2
                },
                {
                  "FEAT_DESC": "1981-02-01",
                  "LIB_FEAT_ID": 24
                }
              ]
            }
          ],
          "DRLIC": [
            {
              "FEAT_DESC": "DL11111 NV",
              "LIB_FEAT_ID": 9,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "DL11111 NV",
                  "LIB_FEAT_ID": 9
                }
              ]
            }
          ],
          "EMAIL": [
            {
              "FEAT_DESC": "BOB@JONESFAMILY.COM",
              "LIB_FEAT_ID": 12,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "BOB@JONESFAMILY.COM",
                  "LIB_FEAT_ID": 12
                }
              ]
            }
          ],
          "GENDER": [
            {
              "FEAT_DESC": "M",
              "LIB_FEAT_ID": 3,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "M",
                  "LIB_FEAT_ID": 3
                }
              ]
            }
          ],
          "LOGIN_ID": [
            {
              "FEAT_DESC": "@BOBJONES27",
              "LIB_FEAT_ID": 11,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "@BOBJONES27",
                  "LIB_FEAT_ID": 11
                }
              ]
            }
          ],
          "NAME": [
            {
              "FEAT_DESC": "ROBERT M JONES",
              "LIB_FEAT_ID": 1,
              "UTYPE_CODE": "PRIMARY",
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "ROBERT M JONES",
                  "LIB_FEAT_ID": 1
                },
                {
                  "FEAT_DESC": "BOBBY JONES",
                  "LIB_FEAT_ID": 23
                }
              ]
            }
          ],
          "PASSPORT": [
            {
              "FEAT_DESC": "PP11111 US",
              "LIB_FEAT_ID": 10,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "PP11111 US",
                  "LIB_FEAT_ID": 10
                }
              ]
            }
          ],
          "PHONE": [
            {
              "FEAT_DESC": "702-222-2222",
              "LIB_FEAT_ID": 6,
              "UTYPE_CODE": "CELL",
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "702-222-2222",
                  "LIB_FEAT_ID": 6
                }
              ]
            },
            {
              "FEAT_DESC": "800-201-2001",
              "LIB_FEAT_ID": 7,
              "UTYPE_CODE": "WORK",
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "800-201-2001",
                  "LIB_FEAT_ID": 7
                }
              ]
            }
          ],
          "SSN": [
            {
              "FEAT_DESC": "311-11-1111",
              "LIB_FEAT_ID": 8,
              "FEAT_DESC_VALUES": [
                {
                  "FEAT_DESC": "311-11-1111",
                  "LIB_FEAT_ID": 8
                }
              ]
            }
          ]
        },
        "MATCH_SCORES": {
          "DOB": [
            {
              "INBOUND_FEAT": "1981-01-02",
              "CANDIDATE_FEAT": "1981-01-02",
              "FULL_SCORE": 100
            }
          ],
          "EMAIL": [
            {
              "INBOUND_FEAT": "BOB@JONESFAMILY.COM",
              "CANDIDATE_FEAT": "BOB@JONESFAMILY.COM",
              "FULL_SCORE": 100
            }
          ]
        },
        "RECORDS": [
          {
            "JSON_DATA": {
              "CELL_PHONE_NUMBER": "702-222-2222",
              "DATA_SOURCE": "PEOPLE",
              "DATE_OF_BIRTH": "1/2/1981",
              "DRIVERS_LICENSE_NUMBER": "DL11111",
              "DRIVERS_LICENSE_STATE": "NV",
              "DSRC_ACTION": "A",
              "EMAIL_ADDRESS": "bob@jonesfamily.com",
              "ENTITY_TYPE": "PEOPLE",
              "GENDER": "M",
              "HOME_ADDR_CITY": "Las Vegas",
              "HOME_ADDR_COUNTRY": "US",
              "HOME_ADDR_LINE1": "111 First St",
              "HOME_ADDR_LINE2": "",
              "HOME_ADDR_LINE3": "",
              "HOME_ADDR_POSTAL_CODE": "89111",
              "HOME_ADDR_STATE": "NV",
              "LOAD_ID": "sample_person.csv",
              "MAIL_ADDR_CITY": "Las Vegas",
              "MAIL_ADDR_COUNTRY": "US",
              "MAIL_ADDR_LINE1": "PO Box 111",
              "MAIL_ADDR_LINE2": "",
              "MAIL_ADDR_LINE3": "",
              "MAIL_ADDR_POSTAL_CODE": "89111",
              "MAIL_ADDR_STATE": "NV",
              "NIN_COUNTRY": "",
              "NIN_NUMBER": "",
              "PASSPORT_COUNTRY": "US",
              "PASSPORT_NUMBER": "PP11111",
              "PRIMARY_NAME_FIRST": "Robert",
              "PRIMARY_NAME_LAST": "Jones",
              "PRIMARY_NAME_MIDDLE": "M",
              "PRIMARY_NAME_PREFIX": "Mr",
              "PRIMARY_NAME_SUFFIX": "Jr",
              "RECORD_ID": "1001",
              "SOCIAL_HANDLE": "@bobjones27",
              "SOCIAL_NETWORK": "twitter",
              "SSN_NUMBER": "311-11-1111",
              "WORK_PHONE_NUMBER": "800-201-2001",
              "ENTITY_KEY": "385E9EEC1A7C66575F0184A1371D564F2B8BD673",
              "ENTITY_NAME": "Mr Robert M Jones Jr",
              "MATCH_KEY": "",
              "MATCH_SCORE": "",
              "ERRULE_CODE": "",
              "REF_SCORE": 0,
              "MATCH_LEVEL": 0
            },
            "NAME_DATA": [
              "PRIMARY: Jones Robert M Mr Jr"
            ],
            "ATTRIBUTE_DATA": [
              "DOB: 1/2/1981",
              "GENDER: M"
            ],
            "IDENTIFIER_DATA": [
              "DRLIC: DL11111 NV",
              "EMAIL: bob@jonesfamily.com",
              "LOGIN_ID: twitter @bobjones27",
              "PASSPORT: PP11111 US",
              "SSN: 311-11-1111"
            ],
            "ADDRESS_DATA": [
              "HOME: 111 First St Las Vegas NV 89111 US",
              "MAIL: PO Box 111 Las Vegas NV 89111 US"
            ],
            "PHONE_DATA": [
              "CELL: 702-222-2222",
              "WORK: 800-201-2001"
            ],
            "RELATIONSHIP_DATA": [],
            "ENTITY_DATA": [],
            "OTHER_DATA": []
          },
          {
            "JSON_DATA": {
              "CELL_PHONE_NUMBER": "",
              "DATA_SOURCE": "PEOPLE",
              "DATE_OF_BIRTH": "2/1/1981",
              "DRIVERS_LICENSE_NUMBER": "",
              "DRIVERS_LICENSE_STATE": "",
              "DSRC_ACTION": "A",
              "EMAIL_ADDRESS": "",
              "ENTITY_TYPE": "PEOPLE",
              "GENDER": "M",
              "HOME_ADDR_CITY": "Las Vegas",
              "HOME_ADDR_COUNTRY": "",
              "HOME_ADDR_LINE1": "111 1st St",
              "HOME_ADDR_LINE2": "",
              "HOME_ADDR_LINE3": "",
              "HOME_ADDR_POSTAL_CODE": "89222",
              "HOME_ADDR_STATE": "NV",
              "LOAD_ID": "sample_person.csv",
              "MAIL_ADDR_CITY": "",
              "MAIL_ADDR_COUNTRY": "",
              "MAIL_ADDR_LINE1": "",
              "MAIL_ADDR_LINE2": "",
              "MAIL_ADDR_LINE3": "",
              "MAIL_ADDR_POSTAL_CODE": "",
              "MAIL_ADDR_STATE": "",
              "NIN_COUNTRY": "",
              "NIN_NUMBER": "",
              "PASSPORT_COUNTRY": "",
              "PASSPORT_NUMBER": "",
              "PRIMARY_NAME_FIRST": "Bobby",
              "PRIMARY_NAME_LAST": "Jones",
              "PRIMARY_NAME_MIDDLE": "",
              "PRIMARY_NAME_PREFIX": "",
              "PRIMARY_NAME_SUFFIX": "",
              "RECORD_ID": "1002",
              "SOCIAL_HANDLE": "",
              "SOCIAL_NETWORK": "",
              "SSN_NUMBER": "",
              "WORK_PHONE_NUMBER": "",
              "ENTITY_KEY": "FF1C69034FA4B3D82193A42843937478EBA2CB61",
              "ENTITY_NAME": "Bobby Jones",
              "MATCH_KEY": "+NAME+DOB+GENDER+ADDRESS",
              "MATCH_SCORE": "14",
              "ERRULE_CODE": "CNAME_CFF_CEXCL",
              "REF_SCORE": 8,
              "MATCH_LEVEL": 1
            },
            "NAME_DATA": [
              "PRIMARY: Jones Bobby"
            ],
            "ATTRIBUTE_DATA": [
              "DOB: 2/1/1981",
              "GENDER: M"
            ],
            "IDENTIFIER_DATA": [],
            "ADDRESS_DATA": [
              "HOME: 111 1st St Las Vegas NV 89222"
            ],
            "PHONE_DATA": [],
            "RELATIONSHIP_DATA": [],
            "ENTITY_DATA": [],
            "OTHER_DATA": []
          }
        ]
      }
    ]
  }
}

A sample parsed search response message is displayed on the right, with comments below to explain the contents. Output is from the sample data and search shown above.
--------------------------------------------------------------------------
Start of response - this example is a search response
Entity(s) matching search request

Unique Entity ID for the entity
Matching details for the search request



Features comprising this entity
Address features
Same or similar addresses grouped together
Address considered most complete
Usage type mapped for the feature
Similar address features to one considered most complete






Second address

Usage type mapped for the feature





Date of Birth features










Drivers License features







Email Address features








Gender features







Login ID features








Name features











Passport features







Phone features
















Social Security Number features








Comparison scores for matching features from the search

Inbound is the feature from the search
Candidate is the feature from an entity that matched
Score for the feature being compared







Source records and mapped features comprising this entity
Start of 1st source record
Exact features and data sent for this record
Data Source name identifying source of record(s)





















Record ID identifying record in source








All name data from mapped features

All attribute data from mapped features


All identifier data from mapped features




All address data from mapped features


All phone data from mapped features


All disclosed relationship data from mapped features
Future use
All other unmapped and ingested data
Start of 2nd source record for this entity




























Matching details for source records comprising this entity
Details why the source records resolved into single entity

Example Get Entity Response Message

From the sample data request to return the entity with ID = 4

(g2) getEntityByEntityID 4 {"RESOLVED_ENTITY":{"ENTITY_ID":4,"LENS_ID":1,"FEATURES":{"ADDRESS":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4,"UTYPE_CODE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4}]}],"DOB":[{"FEAT_DESC":"1982-02-02","LIB_FEAT_ID":38,"FEAT_DESC_VALUES":[{"FEAT_DESC":"1982-02-02","LIB_FEAT_ID":38}]}],"DRLIC":[{"FEAT_DESC":"DL22222 NV","LIB_FEAT_ID":42,"FEAT_DESC_VALUES":[{"FEAT_DESC":"DL22222 NV","LIB_FEAT_ID":42}]}],"EMAIL":[{"FEAT_DESC":"BETH@JONESFAMILY.COM","LIB_FEAT_ID":44,"FEAT_DESC_VALUES":[{"FEAT_DESC":"BETH@JONESFAMILY.COM","LIB_FEAT_ID":44}]}],"GENDER":[{"FEAT_DESC":"F","LIB_FEAT_ID":39,"FEAT_DESC_VALUES":[{"FEAT_DESC":"F","LIB_FEAT_ID":39}]}],"NAME":[{"FEAT_DESC":"ELIZABETH R JONES","LIB_FEAT_ID":37,"UTYPE_CODE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"ELIZABETH R JONES","LIB_FEAT_ID":37}]}],"PASSPORT":[{"FEAT_DESC":"PP22222 US","LIB_FEAT_ID":43,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PP22222 US","LIB_FEAT_ID":43}]}],"PHONE":[{"FEAT_DESC":"702-333-3333","LIB_FEAT_ID":40,"UTYPE_CODE":"CELL","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-333-3333","LIB_FEAT_ID":40}]}],"SSN":[{"FEAT_DESC":"322-22-2222","LIB_FEAT_ID":41,"FEAT_DESC_VALUES":[{"FEAT_DESC":"322-22-2222","LIB_FEAT_ID":41}]}]},"RECORDS":[{"JSON_DATA":{"CELL_PHONE_NUMBER":"702-333-3333","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"2/2/1982","DRIVERS_LICENSE_NUMBER":"DL22222","DRIVERS_LICENSE_STATE":"NV","DSRC_ACTION":"A","EMAIL_ADDRESS":"beth@jonesfamily.com","ENTITY_TYPE":"PEOPLE","GENDER":"F","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"US","HOME_ADDR_LINE1":"111 First St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89111","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"","MAIL_ADDR_COUNTRY":"","MAIL_ADDR_LINE1":"","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"","MAIL_ADDR_STATE":"","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"US","PASSPORT_NUMBER":"PP22222","PRIMARY_NAME_FIRST":"Elizabeth","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"R","PRIMARY_NAME_PREFIX":"Ms","PRIMARY_NAME_SUFFIX":"","RECORD_ID":"1004","SOCIAL_HANDLE":"","SOCIAL_NETWORK":"","SSN_NUMBER":"322-22-2222","WORK_PHONE_NUMBER":"","ENTITY_KEY":"698E526AB9D3F7371875389BCDF3726D0F0A4005","ENTITY_NAME":"Ms Elizabeth R Jones","MATCH_KEY":"","MATCH_SCORE":"","ERRULE_CODE":"","REF_SCORE":0,"MATCH_LEVEL":0},"NAME_DATA":["PRIMARY: Jones Elizabeth R Ms"],"ATTRIBUTE_DATA":["DOB: 2/2/1982","GENDER: F"],"IDENTIFIER_DATA":["DRLIC: DL22222 NV","EMAIL: beth@jonesfamily.com","PASSPORT: PP22222 US","SSN: 322-22-2222"],"ADDRESS_DATA":["HOME: 111 First St Las Vegas NV 89111 US"],"PHONE_DATA":["CELL: 702-333-3333"],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]}]},"RELATED_ENTITIES":[{"ENTITY_ID":1,"LENS_ID":1,"MATCH_LEVEL":3,"MATCH_KEY":"+SURNAME+ADDRESS-GENDER-SSN-DRLIC-PASSPORT","MATCH_SCORE":"12","ERRULE_CODE":"CFF_SURNAME","REF_SCORE":4,"FEATURES":{"ADDRESS":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4,"UTYPE_CODE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"111 FIRST ST LAS VEGAS NV 89111","LIB_FEAT_ID":4},{"FEAT_DESC":"111 1ST ST LAS VEGAS NV 89222","LIB_FEAT_ID":25}]},{"FEAT_DESC":"PO BOX 111 LAS VEGAS NV 89111","LIB_FEAT_ID":5,"UTYPE_CODE":"MAIL","FEAT_DESC_VALUES":[{"FEAT_DESC":"PO BOX 111 LAS VEGAS NV 89111","LIB_FEAT_ID":5}]}],"DOB":[{"FEAT_DESC":"1981-01-02","LIB_FEAT_ID":2,"FEAT_DESC_VALUES":[{"FEAT_DESC":"1981-01-02","LIB_FEAT_ID":2},{"FEAT_DESC":"1981-02-01","LIB_FEAT_ID":24}]}],"DRLIC":[{"FEAT_DESC":"DL11111 NV","LIB_FEAT_ID":9,"FEAT_DESC_VALUES":[{"FEAT_DESC":"DL11111 NV","LIB_FEAT_ID":9}]}],"EMAIL":[{"FEAT_DESC":"BOB@JONESFAMILY.COM","LIB_FEAT_ID":12,"FEAT_DESC_VALUES":[{"FEAT_DESC":"BOB@JONESFAMILY.COM","LIB_FEAT_ID":12}]}],"GENDER":[{"FEAT_DESC":"M","LIB_FEAT_ID":3,"FEAT_DESC_VALUES":[{"FEAT_DESC":"M","LIB_FEAT_ID":3}]}],"LOGIN_ID":[{"FEAT_DESC":"@BOBJONES27","LIB_FEAT_ID":11,"FEAT_DESC_VALUES":[{"FEAT_DESC":"@BOBJONES27","LIB_FEAT_ID":11}]}],"NAME":[{"FEAT_DESC":"ROBERT M JONES","LIB_FEAT_ID":1,"UTYPE_CODE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"ROBERT M JONES","LIB_FEAT_ID":1},{"FEAT_DESC":"BOBBY JONES","LIB_FEAT_ID":23}]}],"PASSPORT":[{"FEAT_DESC":"PP11111 US","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PP11111 US","LIB_FEAT_ID":10}]}],"PHONE":[{"FEAT_DESC":"702-222-2222","LIB_FEAT_ID":6,"UTYPE_CODE":"CELL","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-222-2222","LIB_FEAT_ID":6}]},{"FEAT_DESC":"800-201-2001","LIB_FEAT_ID":7,"UTYPE_CODE":"WORK","FEAT_DESC_VALUES":[{"FEAT_DESC":"800-201-2001","LIB_FEAT_ID":7}]}],"SSN":[{"FEAT_DESC":"311-11-1111","LIB_FEAT_ID":8,"FEAT_DESC_VALUES":[{"FEAT_DESC":"311-11-1111","LIB_FEAT_ID":8}]}]},"RECORDS":[{"JSON_DATA":{"CELL_PHONE_NUMBER":"702-222-2222","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"1/2/1981","DRIVERS_LICENSE_NUMBER":"DL11111","DRIVERS_LICENSE_STATE":"NV","DSRC_ACTION":"A","EMAIL_ADDRESS":"bob@jonesfamily.com","ENTITY_TYPE":"PEOPLE","GENDER":"M","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"US","HOME_ADDR_LINE1":"111 First St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89111","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"Las Vegas","MAIL_ADDR_COUNTRY":"US","MAIL_ADDR_LINE1":"PO Box 111","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"89111","MAIL_ADDR_STATE":"NV","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"US","PASSPORT_NUMBER":"PP11111","PRIMARY_NAME_FIRST":"Robert","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"M","PRIMARY_NAME_PREFIX":"Mr","PRIMARY_NAME_SUFFIX":"Jr","RECORD_ID":"1001","SOCIAL_HANDLE":"@bobjones27","SOCIAL_NETWORK":"twitter","SSN_NUMBER":"311-11-1111","WORK_PHONE_NUMBER":"800-201-2001","ENTITY_KEY":"385E9EEC1A7C66575F0184A1371D564F2B8BD673","ENTITY_NAME":"Mr Robert M Jones Jr","MATCH_KEY":"","MATCH_SCORE":"","ERRULE_CODE":"","REF_SCORE":0,"MATCH_LEVEL":0},"NAME_DATA":["PRIMARY: Jones Robert M Mr Jr"],"ATTRIBUTE_DATA":["DOB: 1/2/1981","GENDER: M"],"IDENTIFIER_DATA":["DRLIC: DL11111 NV","EMAIL: bob@jonesfamily.com","LOGIN_ID: twitter @bobjones27","PASSPORT: PP11111 US","SSN: 311-11-1111"],"ADDRESS_DATA":["HOME: 111 First St Las Vegas NV 89111 US","MAIL: PO Box 111 Las Vegas NV 89111 US"],"PHONE_DATA":["CELL: 702-222-2222","WORK: 800-201-2001"],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]},{"JSON_DATA":{"CELL_PHONE_NUMBER":"","DATA_SOURCE":"PEOPLE","DATE_OF_BIRTH":"2/1/1981","DRIVERS_LICENSE_NUMBER":"","DRIVERS_LICENSE_STATE":"","DSRC_ACTION":"A","EMAIL_ADDRESS":"","ENTITY_TYPE":"PEOPLE","GENDER":"M","HOME_ADDR_CITY":"Las Vegas","HOME_ADDR_COUNTRY":"","HOME_ADDR_LINE1":"111 1st St","HOME_ADDR_LINE2":"","HOME_ADDR_LINE3":"","HOME_ADDR_POSTAL_CODE":"89222","HOME_ADDR_STATE":"NV","LOAD_ID":"sample_person.csv","MAIL_ADDR_CITY":"","MAIL_ADDR_COUNTRY":"","MAIL_ADDR_LINE1":"","MAIL_ADDR_LINE2":"","MAIL_ADDR_LINE3":"","MAIL_ADDR_POSTAL_CODE":"","MAIL_ADDR_STATE":"","NIN_COUNTRY":"","NIN_NUMBER":"","PASSPORT_COUNTRY":"","PASSPORT_NUMBER":"","PRIMARY_NAME_FIRST":"Bobby","PRIMARY_NAME_LAST":"Jones","PRIMARY_NAME_MIDDLE":"","PRIMARY_NAME_PREFIX":"","PRIMARY_NAME_SUFFIX":"","RECORD_ID":"1002","SOCIAL_HANDLE":"","SOCIAL_NETWORK":"","SSN_NUMBER":"","WORK_PHONE_NUMBER":"","ENTITY_KEY":"FF1C69034FA4B3D82193A42843937478EBA2CB61","ENTITY_NAME":"Bobby Jones","MATCH_KEY":"+NAME+DOB+GENDER+ADDRESS","MATCH_SCORE":"14","ERRULE_CODE":"CNAME_CFF_CEXCL","REF_SCORE":8,"MATCH_LEVEL":1},"NAME_DATA":["PRIMARY: Jones Bobby"],"ATTRIBUTE_DATA":["DOB: 2/1/1981","GENDER: M"],"IDENTIFIER_DATA":[],"ADDRESS_DATA":["HOME: 111 1st St Las Vegas NV 89222"],"PHONE_DATA":[],"RELATIONSHIP_DATA":[],"ENTITY_DATA":[],"OTHER_DATA":[]}]}]} (g2)

Example response (jq):

{
  "RESOLVED_ENTITY": {
    "ENTITY_ID": 4,
    "LENS_ID": 1,
    "FEATURES": {
      "ADDRESS": [
        {
          "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111",
          "LIB_FEAT_ID": 4,
          "UTYPE_CODE": "HOME",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111",
              "LIB_FEAT_ID": 4
            }
          ]
        }
      ],
      "DOB": [
        {
          "FEAT_DESC": "1982-02-02",
          "LIB_FEAT_ID": 38,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "1982-02-02",
              "LIB_FEAT_ID": 38
            }
          ]
        }
      ],
      "DRLIC": [
        {
          "FEAT_DESC": "DL22222 NV",
          "LIB_FEAT_ID": 42,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "DL22222 NV",
              "LIB_FEAT_ID": 42
            }
          ]
        }
      ],
      "EMAIL": [
        {
          "FEAT_DESC": "BETH@JONESFAMILY.COM",
          "LIB_FEAT_ID": 44,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "BETH@JONESFAMILY.COM",
              "LIB_FEAT_ID": 44
            }
          ]
        }
      ],
      "GENDER": [
        {
          "FEAT_DESC": "F",
          "LIB_FEAT_ID": 39,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "F",
              "LIB_FEAT_ID": 39
            }
          ]
        }
      ],
      "NAME": [
        {
          "FEAT_DESC": "ELIZABETH R JONES",
          "LIB_FEAT_ID": 37,
          "UTYPE_CODE": "PRIMARY",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "ELIZABETH R JONES",
              "LIB_FEAT_ID": 37
            }
          ]
        }
      ],
      "PASSPORT": [
        {
          "FEAT_DESC": "PP22222 US",
          "LIB_FEAT_ID": 43,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "PP22222 US",
              "LIB_FEAT_ID": 43
            }
          ]
        }
      ],
      "PHONE": [
        {
          "FEAT_DESC": "702-333-3333",
          "LIB_FEAT_ID": 40,
          "UTYPE_CODE": "CELL",
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "702-333-3333",
              "LIB_FEAT_ID": 40
            }
          ]
        }
      ],
      "SSN": [
        {
          "FEAT_DESC": "322-22-2222",
          "LIB_FEAT_ID": 41,
          "FEAT_DESC_VALUES": [
            {
              "FEAT_DESC": "322-22-2222",
              "LIB_FEAT_ID": 41
            }
          ]
        }
      ]
    },
    "RECORDS": [
      {
        "JSON_DATA": {
          "CELL_PHONE_NUMBER": "702-333-3333",
          "DATA_SOURCE": "PEOPLE",
          "DATE_OF_BIRTH": "2/2/1982",
          "DRIVERS_LICENSE_NUMBER": "DL22222",
          "DRIVERS_LICENSE_STATE": "NV",
          "DSRC_ACTION": "A",
          "EMAIL_ADDRESS": "beth@jonesfamily.com",
          "ENTITY_TYPE": "PEOPLE",
          "GENDER": "F",
          "HOME_ADDR_CITY": "Las Vegas",
          "HOME_ADDR_COUNTRY": "US",
          "HOME_ADDR_LINE1": "111 First St",
          "HOME_ADDR_LINE2": "",
          "HOME_ADDR_LINE3": "",
          "HOME_ADDR_POSTAL_CODE": "89111",
          "HOME_ADDR_STATE": "NV",
          "LOAD_ID": "sample_person.csv",
          "MAIL_ADDR_CITY": "",
          "MAIL_ADDR_COUNTRY": "",
          "MAIL_ADDR_LINE1": "",
          "MAIL_ADDR_LINE2": "",
          "MAIL_ADDR_LINE3": "",
          "MAIL_ADDR_POSTAL_CODE": "",
          "MAIL_ADDR_STATE": "",
          "NIN_COUNTRY": "",
          "NIN_NUMBER": "",
          "PASSPORT_COUNTRY": "US",
          "PASSPORT_NUMBER": "PP22222",
          "PRIMARY_NAME_FIRST": "Elizabeth",
          "PRIMARY_NAME_LAST": "Jones",
          "PRIMARY_NAME_MIDDLE": "R",
          "PRIMARY_NAME_PREFIX": "Ms",
          "PRIMARY_NAME_SUFFIX": "",
          "RECORD_ID": "1004",
          "SOCIAL_HANDLE": "",
          "SOCIAL_NETWORK": "",
          "SSN_NUMBER": "322-22-2222",
          "WORK_PHONE_NUMBER": "",
          "ENTITY_KEY": "698E526AB9D3F7371875389BCDF3726D0F0A4005",
          "ENTITY_NAME": "Ms Elizabeth R Jones",
          "MATCH_KEY": "",
          "MATCH_SCORE": "",
          "ERRULE_CODE": "",
          "REF_SCORE": 0,
          "MATCH_LEVEL": 0
        },
        "NAME_DATA": [
          "PRIMARY: Jones Elizabeth R Ms"
        ],
        "ATTRIBUTE_DATA": [
          "DOB: 2/2/1982",
          "GENDER: F"
        ],
        "IDENTIFIER_DATA": [
          "DRLIC: DL22222 NV",
          "EMAIL: beth@jonesfamily.com",
          "PASSPORT: PP22222 US",
          "SSN: 322-22-2222"
        ],
        "ADDRESS_DATA": [
          "HOME: 111 First St Las Vegas NV 89111 US"
        ],
        "PHONE_DATA": [
          "CELL: 702-333-3333"
        ],
        "RELATIONSHIP_DATA": [],
        "ENTITY_DATA": [],
        "OTHER_DATA": []
      }
    ]
  },
  "RELATED_ENTITIES": [
    {
      "ENTITY_ID": 1,
      "LENS_ID": 1,
      "MATCH_LEVEL": 3,
      "MATCH_KEY": "+SURNAME+ADDRESS-GENDER-SSN-DRLIC-PASSPORT",
      "MATCH_SCORE": "12",
      "ERRULE_CODE": "CFF_SURNAME",
      "REF_SCORE": 4,
      "FEATURES": {
        "ADDRESS": [
          {
            "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111",
            "LIB_FEAT_ID": 4,
            "UTYPE_CODE": "HOME",
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "111 FIRST ST LAS VEGAS NV 89111",
                "LIB_FEAT_ID": 4
              },
              {
                "FEAT_DESC": "111 1ST ST LAS VEGAS NV 89222",
                "LIB_FEAT_ID": 25
              }
            ]
          },
          {
            "FEAT_DESC": "PO BOX 111 LAS VEGAS NV 89111",
            "LIB_FEAT_ID": 5,
            "UTYPE_CODE": "MAIL",
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "PO BOX 111 LAS VEGAS NV 89111",
                "LIB_FEAT_ID": 5
              }
            ]
          }
        ],
        "DOB": [
          {
            "FEAT_DESC": "1981-01-02",
            "LIB_FEAT_ID": 2,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "1981-01-02",
                "LIB_FEAT_ID": 2
              },
              {
                "FEAT_DESC": "1981-02-01",
                "LIB_FEAT_ID": 24
              }
            ]
          }
        ],
        "DRLIC": [
          {
            "FEAT_DESC": "DL11111 NV",
            "LIB_FEAT_ID": 9,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "DL11111 NV",
                "LIB_FEAT_ID": 9
              }
            ]
          }
        ],
        "EMAIL": [
          {
            "FEAT_DESC": "BOB@JONESFAMILY.COM",
            "LIB_FEAT_ID": 12,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "BOB@JONESFAMILY.COM",
                "LIB_FEAT_ID": 12
              }
            ]
          }
        ],
        "GENDER": [
          {
            "FEAT_DESC": "M",
            "LIB_FEAT_ID": 3,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "M",
                "LIB_FEAT_ID": 3
              }
            ]
          }
        ],
        "LOGIN_ID": [
          {
            "FEAT_DESC": "@BOBJONES27",
            "LIB_FEAT_ID": 11,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "@BOBJONES27",
                "LIB_FEAT_ID": 11
              }
            ]
          }
        ],
        "NAME": [
          {
            "FEAT_DESC": "ROBERT M JONES",
            "LIB_FEAT_ID": 1,
            "UTYPE_CODE": "PRIMARY",
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "ROBERT M JONES",
                "LIB_FEAT_ID": 1
              },
              {
                "FEAT_DESC": "BOBBY JONES",
                "LIB_FEAT_ID": 23
              }
            ]
          }
        ],
        "PASSPORT": [
          {
            "FEAT_DESC": "PP11111 US",
            "LIB_FEAT_ID": 10,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "PP11111 US",
                "LIB_FEAT_ID": 10
              }
            ]
          }
        ],
        "PHONE": [
          {
            "FEAT_DESC": "702-222-2222",
            "LIB_FEAT_ID": 6,
            "UTYPE_CODE": "CELL",
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "702-222-2222",
                "LIB_FEAT_ID": 6
              }
            ]
          },
          {
            "FEAT_DESC": "800-201-2001",
            "LIB_FEAT_ID": 7,
            "UTYPE_CODE": "WORK",
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "800-201-2001",
                "LIB_FEAT_ID": 7
              }
            ]
          }
        ],
        "SSN": [
          {
            "FEAT_DESC": "311-11-1111",
            "LIB_FEAT_ID": 8,
            "FEAT_DESC_VALUES": [
              {
                "FEAT_DESC": "311-11-1111",
                "LIB_FEAT_ID": 8
              }
            ]
          }
        ]
      },
      "RECORDS": [
        {
          "JSON_DATA": {
            "CELL_PHONE_NUMBER": "702-222-2222",
            "DATA_SOURCE": "PEOPLE",
            "DATE_OF_BIRTH": "1/2/1981",
            "DRIVERS_LICENSE_NUMBER": "DL11111",
            "DRIVERS_LICENSE_STATE": "NV",
            "DSRC_ACTION": "A",
            "EMAIL_ADDRESS": "bob@jonesfamily.com",
            "ENTITY_TYPE": "PEOPLE",
            "GENDER": "M",
            "HOME_ADDR_CITY": "Las Vegas",
            "HOME_ADDR_COUNTRY": "US",
            "HOME_ADDR_LINE1": "111 First St",
            "HOME_ADDR_LINE2": "",
            "HOME_ADDR_LINE3": "",
            "HOME_ADDR_POSTAL_CODE": "89111",
            "HOME_ADDR_STATE": "NV",
            "LOAD_ID": "sample_person.csv",
            "MAIL_ADDR_CITY": "Las Vegas",
            "MAIL_ADDR_COUNTRY": "US",
            "MAIL_ADDR_LINE1": "PO Box 111",
            "MAIL_ADDR_LINE2": "",
            "MAIL_ADDR_LINE3": "",
            "MAIL_ADDR_POSTAL_CODE": "89111",
            "MAIL_ADDR_STATE": "NV",
            "NIN_COUNTRY": "",
            "NIN_NUMBER": "",
            "PASSPORT_COUNTRY": "US",
            "PASSPORT_NUMBER": "PP11111",
            "PRIMARY_NAME_FIRST": "Robert",
            "PRIMARY_NAME_LAST": "Jones",
            "PRIMARY_NAME_MIDDLE": "M",
            "PRIMARY_NAME_PREFIX": "Mr",
            "PRIMARY_NAME_SUFFIX": "Jr",
            "RECORD_ID": "1001",
            "SOCIAL_HANDLE": "@bobjones27",
            "SOCIAL_NETWORK": "twitter",
            "SSN_NUMBER": "311-11-1111",
            "WORK_PHONE_NUMBER": "800-201-2001",
            "ENTITY_KEY": "385E9EEC1A7C66575F0184A1371D564F2B8BD673",
            "ENTITY_NAME": "Mr Robert M Jones Jr",
            "MATCH_KEY": "",
            "MATCH_SCORE": "",
            "ERRULE_CODE": "",
            "REF_SCORE": 0,
            "MATCH_LEVEL": 0
          },
          "NAME_DATA": [
            "PRIMARY: Jones Robert M Mr Jr"
          ],
          "ATTRIBUTE_DATA": [
            "DOB: 1/2/1981",
            "GENDER: M"
          ],
          "IDENTIFIER_DATA": [
            "DRLIC: DL11111 NV",
            "EMAIL: bob@jonesfamily.com",
            "LOGIN_ID: twitter @bobjones27",
            "PASSPORT: PP11111 US",
            "SSN: 311-11-1111"
          ],
          "ADDRESS_DATA": [
            "HOME: 111 First St Las Vegas NV 89111 US",
            "MAIL: PO Box 111 Las Vegas NV 89111 US"
          ],
          "PHONE_DATA": [
            "CELL: 702-222-2222",
            "WORK: 800-201-2001"
          ],
          "RELATIONSHIP_DATA": [],
          "ENTITY_DATA": [],
          "OTHER_DATA": []
        },
        {
          "JSON_DATA": {
            "CELL_PHONE_NUMBER": "",
            "DATA_SOURCE": "PEOPLE",
            "DATE_OF_BIRTH": "2/1/1981",
            "DRIVERS_LICENSE_NUMBER": "",
            "DRIVERS_LICENSE_STATE": "",
            "DSRC_ACTION": "A",
            "EMAIL_ADDRESS": "",
            "ENTITY_TYPE": "PEOPLE",
            "GENDER": "M",
            "HOME_ADDR_CITY": "Las Vegas",
            "HOME_ADDR_COUNTRY": "",
            "HOME_ADDR_LINE1": "111 1st St",
            "HOME_ADDR_LINE2": "",
            "HOME_ADDR_LINE3": "",
            "HOME_ADDR_POSTAL_CODE": "89222",
            "HOME_ADDR_STATE": "NV",
            "LOAD_ID": "sample_person.csv",
            "MAIL_ADDR_CITY": "",
            "MAIL_ADDR_COUNTRY": "",
            "MAIL_ADDR_LINE1": "",
            "MAIL_ADDR_LINE2": "",
            "MAIL_ADDR_LINE3": "",
            "MAIL_ADDR_POSTAL_CODE": "",
            "MAIL_ADDR_STATE": "",
            "NIN_COUNTRY": "",
            "NIN_NUMBER": "",
            "PASSPORT_COUNTRY": "",
            "PASSPORT_NUMBER": "",
            "PRIMARY_NAME_FIRST": "Bobby",
            "PRIMARY_NAME_LAST": "Jones",
            "PRIMARY_NAME_MIDDLE": "",
            "PRIMARY_NAME_PREFIX": "",
            "PRIMARY_NAME_SUFFIX": "",
            "RECORD_ID": "1002",
            "SOCIAL_HANDLE": "",
            "SOCIAL_NETWORK": "",
            "SSN_NUMBER": "",
            "WORK_PHONE_NUMBER": "",
            "ENTITY_KEY": "FF1C69034FA4B3D82193A42843937478EBA2CB61",
            "ENTITY_NAME": "Bobby Jones",
            "MATCH_KEY": "+NAME+DOB+GENDER+ADDRESS",
            "MATCH_SCORE": "14",
            "ERRULE_CODE": "CNAME_CFF_CEXCL",
            "REF_SCORE": 8,
            "MATCH_LEVEL": 1
          },
          "NAME_DATA": [
            "PRIMARY: Jones Bobby"
          ],
          "ATTRIBUTE_DATA": [
            "DOB: 2/1/1981",
            "GENDER: M"
          ],
          "IDENTIFIER_DATA": [],
          "ADDRESS_DATA": [
            "HOME: 111 1st St Las Vegas NV 89222"
          ],
          "PHONE_DATA": [],
          "RELATIONSHIP_DATA": [],
          "ENTITY_DATA": [],
          "OTHER_DATA": []
        }
      ]
    }
  ]
}

The response message is very similar in format and comprehension to the search request.
--------------------------------------------------------------------------
Start of response - this example is a specific entity

Unique Entity ID for the entity
Features comprising this entity
Address features








Date of Birth features








Drivers License features







Email Address features








Gender features







Name features









Passport features







Phone features








Social Security Number features








Source records and mapped features comprising this entity
Start of 1st source record
Exact features and data sent for this record
Data Source name identifying source of record(s)





















Record ID identifying record in source









All name data from mapped features

All attribute data from mapped features

All identifier data from mapped features



All address data from mapped features

All phone data from mapped features

All disclosed relationship data from mapped features
Future use
All other unmapped and ingested data


Discovered relationships to other entities
First discovered relationship
Unique Entity ID for discovered relationship
Matching details for entity with discovered relationship


Features for the source record(s) comprising related entity(s)

Response Message Observations & Notes