An entity document identifies documents that are linked together in a particular way. For example, a person can be linked to a postal address or a person to a phone number.

Calls to the Match Endpoints, Lookup Endpoints, and Doc ID Endpoints can return entity documents by setting the document_class parameter to entities.

Example

Entity document—JSON format

{
  "entity": {
    "id": "3030303000cf2035030f5c51a496422bb2597e170e",
    "personIds": [
      "3030303000d6f74878f01c7936f67c5b741670393a"
    ],
    "placeId": "3030303000d3b05984488cf3b625c013595911655a",
    "abilitec": {
      "consumerLink": "0000US0209B0QRPZ",
      "addressLink": "0000US0309B0QR7T"
    },
    "matchMetadata": {
      "matchComponents": [
        "name",
        "streetAddress",
        "zipCode"
      ]
    }
  }
}