Search for potential matches in Customer Tenants (CT)

Learn more about using the DTSS API to search for potential matches from the Data Tenant within the Customer Tenant.

Use this DTSS operation to find potential matches for one or more entities from the Data Tenant (DT) within the Customer Tenant (CT). This operation is useful when checking if a DT record already exists in the CT before initiating a subscription or import.

Request

Use the following operation to search for potential matches from the Data Tenant (DT) within the Customer Tenant (CT):

POST {DTSSURL}/entities/_matchesForDtEntities

Headers


Name	Required	Description
CustomerTenant	Yes	Customer Tenant ID
DataTenant	Yes	Data Tenant ID

Optional parameters


Name	Location	Type	Value	Description
max	query	integer	For example, 100	A positive integer that defines the maximum number of entities returned in the response.
skipAllImportedEntities	query	boolean	True False Default is false.	If true, hides potential matches from the DT that are already subscribed to by entities in the CT. Default is false.
options	query	string	`sendHidden` is disabled by default. When enabled, the entity's JSON response includes hidden attributes. `ovOnly` returns only attribute values with the ov=true flag. `nonOvOnly` returns only attribute values with the ov=false flag. If a nested or reference attribute has ov=true but its sub-attributes have ov=false, those sub-attributes are not included in the response. `searchByOv` is disabled by default. When enabled, search and sort operations are performed only on attributes where ov=true.	Comma-separated list of different options which affect entity's JSON content in the response
filter	query	string	The format for the filter query parameter is: filter=({Condition Type}[AND/OR {Condition Type}]*)	Enables filtering the entities based on a condition
sources	query	filter	For example, configuration/sources/LNKD	Specifies the crosswalks to use when searching for entities in the Data Tenant

Request body

The body must contain a list of DT entities, either as URIs or full entity objects.

URI-only example:

[
  "entities/0000I77"
]

Full object example:

[
  {
    "uri": "entities/0000I77",
    "type": "configuration/entityTypes/Individual",
    "attributes": {
      "FirstName": [
        {
          "type": "configuration/entityTypes/Individual/attributes/FirstName",
          "ov": true,
          "value": "Ernest",
          "uri": "entities/0000I77/attributes/FirstName/241"
        }
      ],
      "MiddleName": [
        {
          "type": "configuration/entityTypes/Individual/attributes/MiddleName",
          "ov": true,
          "value": "E.",
          "uri": "entities/0000I77/attributes/MiddleName/1vl"
        }
      ]
    }
  }
]

Response

The response returns a JSON array of matched CT entities, excluding entities marked as "not a match."

[
  {
    "index": 0,
    "object": {
      "configuration/entityTypes/Individual/matchGroups/PersonByFullNameInES": [
        {
          "uri": "entities/0000I77",
          "type": "configuration/entityTypes/Individual",
          "attributes": {
            "FirstName": [
              {
                "type": "configuration/entityTypes/Individual/attributes/FirstName",
                "ov": true,
                "value": "Ernest",
                "uri": "entities/0000I77/attributes/FirstName/241"
              }
            ],
            "LastName": [
              {
                "type": "configuration/entityTypes/Individual/attributes/LastName",
                "ov": true,
                "value": "Fusco",
                "uri": "entities/0000I77/attributes/LastName/2CH"
              }
            ]
          }
        }
      ]
    }
  }
]

Unify and manage your data