v3

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

Identifiers

Add Profile Identifier

Asynchronously attach a new identifier value to a profile. When multiple values exist for an idType, ordering, limits, and uniqueness checks are enforced by the corresponding identifier settings limitPolicy and reflect any normalization. If the identifier already exists and points to another profile, resolution rules or merge processes may apply. Use the identifier specific endpoint to inspect, update, or remove existing values.

post/v1/Stores/{storeId}/Profiles/{profileId}/Identifiers

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

Identifier association accepted.

messagestring required

Example response

{
  "message": "Identifier accepted for processing."
}