A group document is returned when the "limit" parameter in a request to the Match endpoint is set to a value greater than "1" and there are more than one matches. The group document will contain a number of documents equal to the number of matches.

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

If a representation is opted-out, this representation will be omitted from the group document response.

The maximum number of documents contained in a group document is 10. Often the number of documents that match the input will be less than the limit, especially when the limit is set closer 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 in JSON format (also shows matchMetadata bundle and contactFlags bundle):

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