A group document is returned when the limit parameter in a request to the Match Endpoints or Lookup Endpoints is set to a value greater than 1. If there are one or more matches, the group document will contain multiple documents, equal to the limit.

Documents are returned in the order they were matched with the best match listed first.

The maximum number of documents contained in a group document is 10. Sometimes the number of documents that match the input is less than the limit, especially when the limit is set close to 10.

The limit parameter does not impact the requirements for a record to become a match; it only allows additional matches to be returned if they exist. Each document inside the group document is counted as a transaction.

Example

Group document—JSON format

{
  "group": {
    "entities": [
      {
        "entity": {
          "id": "3030303000f0fcdec11c864176585b90d37d44b04c",
          "personIds": [
            "303030300043dce117b3383483b7e500cf80810e15"
          ]
        }
      },
      {
        "entity": {
          "id": "3030303000fdf9ce9db8fa2a61f58963e6335f77f5",
          "personIds": [
            "303030300043dce117b3383483b7e500cf80810e15"
          ]
        }
      },
      {
        "entity": {
          "id": "30303030007a60772d7161ebb94524cbca2d3d8481",
          "personIds": [
            "303030300043dce117b3383483b7e500cf80810e15"
          ]
        }
      }
    ]
  }
}