Match groups for entity types
Learn more about how to retrieve, create, update, and delete match groups for an entity type using the Configuration API.
Use the Configuration to retrieve match groups for an entity type, retrieve a specific match group, create a new match group, update a match group, and delete a match group. By default, GET responses include inherited configuration. To exclude inherited configuration, set the inheritance query parameter to false.
HTTP methods and endpoints
Use one of the following HTTP methods and endpoint paths to submit the request:
GET retrieves all match groups for the specified entity type or retrieves a specific match group definition.
GET {TenantURL}/configuration/entityTypes/{entityTypeName}/matchGroups?inheritance=true|false
GET {TenantURL}/configuration/entityTypes/{entityTypeName}/matchGroups/{matchGroupName}?inheritance=true|falsePOST creates a new match group definition for the specified entity type.
POST {TenantURL}/configuration/entityTypes/{entityTypeName}/matchGroups/{matchGroupName}PUT updates the specified match group definition for the entity type.
PUT {TenantURL}/configuration/entityTypes/{entityTypeName}/matchGroups/{matchGroupName}DELETE deletes the specified match group definition for the entity type.
DELETE {TenantURL}/configuration/entityTypes/{entityTypeName}/matchGroups/{matchGroupName}The following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL of your tenant. |
| entityTypeName | Yes | The name of the entity type whose matchGroups sub-resource you want to retrieve or modify. |
| matchGroupName | Yes, for match-group-specific GET, POST, PUT, and DELETE | The name of the match group to retrieve, create, update, or delete. |
Request headers
Include the following headers in the request.
| Name | Required | Description |
|---|---|---|
| Authorization | Yes | Access token used to authenticate the tenant request. |
| Content-Type | Yes, for POST and PUT | application/json |
Query parameters
The following table describes the query parameters.
| Name | Required | Description |
|---|---|---|
| inheritance | No, for GET | Determines whether inherited configuration from base types is included in the response. Accepted values are true and false. Default: true. |
Example requests
The following example retrieves all matchGroups for the Individual entity type and includes inherited configuration.
GET {TenantURL}/configuration/entityTypes/Individual/matchGroups?inheritance=true
Authorization: <access_token>The following example retrieves the ExactNameMatch match group for the Individual entity type.
GET {TenantURL}/configuration/entityTypes/Individual/matchGroups/ExactNameMatch?inheritance=true
Authorization: <access_token>The following example creates the ExactNameMatch match group for the Individual entity type.
POST {TenantURL}/configuration/entityTypes/Individual/matchGroups/ExactNameMatch
Authorization: <access_token>
Content-Type: application/json
<new match group definition>The following example updates the ExactNameMatch match group for the Individual entity type.
PUT {TenantURL}/configuration/entityTypes/Individual/matchGroups/ExactNameMatch
Authorization: <access_token>
Content-Type: application/json
<updated match group definition>The following example deletes the ExactNameMatch match group for the Individual entity type.
DELETE {TenantURL}/configuration/entityTypes/Individual/matchGroups/ExactNameMatch
Authorization: <access_token>Example responses
The following examples show the response pattern for successful and error outcomes.
Successful GET response
HTTP/1.1 200 OK
Content-Type: application/json
<match group definition or list of match groups>Successful POST response
HTTP/1.1 201 Created
Content-Type: application/json
<created match group definition>Successful PUT response
HTTP/1.1 200 OK
Content-Type: application/json
<updated match group definition>Successful DELETE response
HTTP/1.1 204
{
"successful": true
}
Error response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<TYPE_IS_NOT_FOUND, BAD_REQUEST, or VALIDATION_ERROR>