Batch Documents

A batch document is returned for batch requests to either the Match endpoint or the Lookup endpoint. The batch document contains the entity documents for each request that was sent in the POST body.

Responses are returned in the same order that the requests were made in the POST body.

Example

[ {
  "code" : 200,
  "document" : {
    "entity" : {
      "abilitec" : {
        "consumerLink" : "003YUS02XKRLMYCQ",
        "addressLink" : "003YUS136XH7B3BT",
        "householdLink" : "003YUS18Y4Y5X9WT"
      },
      "matchMetadata" : {
        "matchComponents" : [ "name", "zipCode" ],
        "distinctMatch" : false,
        "matchConfidence" : "8",
        "nameMatchIntegrity" : "complete"
      }
    }
  }
}, {
  "code" : 200,
  "document" : {
    "entity" : {
      "abilitec" : {
        "consumerLink" : "003YUS02XKRLMYCQ",
        "addressLink" : "003YUS133J313WBM",
        "householdLink" : "003YUS18MJ8SN8EB"
      },
      "matchMetadata" : {
        "matchComponents" : [ "name", "phone" ],
        "distinctMatch" : true,
        "matchConfidence" : "3",
        "nameMatchIntegrity" : "complete"
      },
      "contactFlags" : {
        "isBestPhoneTouchpoint" : true 
      }
    }
  }
} ]