A group document is returned when the limit parameter in a request to the Match endpoint or Lookup endpoint is set to a value greater than "1" and there is more than one match. 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. 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": {
		"entities": [
			{
				"entity": {
					"anonymousAbilitec": {
						"anonymousConsumerLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
						"anonymousAddressLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
						"anonymousHouseholdLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
					},
					"matchMetadata": {
						"matchComponents": [
							"name",
							"streetAddress",
							"zipCode"
						],
						"distinctMatch": false,
						"matchConfidence": "1",
						"nameMatchIntegrity": "complete"
					}
				}
			},
			{
				"entity": {
					"anonymousAbilitec": {
						"anonymousConsumerLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
						"anonymousAddressLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
						"anonymousHouseholdLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
					},
					"matchMetadata": {
						"matchComponents": [
							"name",
							"email"
						],
						"distinctMatch": false,
						"matchConfidence": "2",
						"nameMatchIntegrity": "complete"
					}
				}
			},
			{
				"entity": {
					"anonymousAbilitec": {
						"anonymousConsumerLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
						"anonymousAddressLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789i",
						"anonymousHouseholdLink": "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
					},
					"matchMetadata": {
						"matchComponents": [
							"name",
							"phone"
						],
						"distinctMatch": false,
						"matchConfidence": "5",
						"nameMatchIntegrity": "partial"
					}
				}
			}
		]
	}
}

📘

Pseudonymous identifier

In the context of the RampID API, references to "anonymousAbilitec" indicate resolving to people-based pseudonymous online identifiers. For more information, see "RampID Methodology" in the Identity documentation.