GET

/domains/{DomainName}/matches

http://profile.{region}.amazonaws.com/domains/{DomainName}/matches

Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to enable identity resolution: set <code>Matching</code> to true. GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. <important> The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3. </important> Amazon Connect uses the following profile attributes to identify matches: <ul> <li> PhoneNumber </li> <li> HomePhoneNumber </li> <li> BusinessPhoneNumber </li> <li> MobilePhoneNumber </li> <li> EmailAddress </li> <li> PersonalEmailAddress </li> <li> BusinessEmailAddress </li> <li> FullName </li> </ul> For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

Access Token Required: API Key

Path Parameters

DomainNamestringrequired

The unique name of the domain.

Query Params

next-tokenstring

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

max-resultsinteger

The maximum number of results to return per page.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://profile.{region}.amazonaws.com/domains/{DomainName}/matches' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET