A household document contains information about a household, including the Household ID and the Person IDs for the members of that household.

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

Example

Household document—JSON format

{
  "household": {
    "id": "5a5a5a5a00f3c1e266b1ed36185b4da43f0c98862e",
    "personIds": [
      "5a5a5a5a00d1259d57e2097710dba53c20a26e7db6",
      "..."
    ],
  }
}