v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB

Retrieval

Lookup Profiles

Find profiles that contain a specific identifier value (for example a phone number or email address). Submit an identifier object specifying the idType and value. The value is normalized using the configured identity resolution settings (such as phone number formatting) prior to matching. Multiple matches are returned if more than one profile is associated with the identifier. Returns canonical profile IDs (the earliest ID if profiles have been merged) along with the normalized value actually searched.

post/v1/Stores/{storeId}/Profiles/Lookup

Request body

idTypestring required

Identifier type as configured in the service's Identity Resolution Settings.

valuestring required

Raw value captured for the identifier. The service may normalize this value according to the normalization rule defined in the identifier settings before storage or matching (for example E.164 formatting for phone numbers).

Example request

{
  "idType": "phone",
  "value": "+13175556789"
}

Response

A list of profiles found.

normalizedValuestring

Identifier value after normalization that was used for the lookup.

profilesIdentityProfileID[]

Example response

{
  "normalizedValue": "+13175556789",
  "profiles": [
    "mem_profile_00000000000000000000000000"
  ]
}