EUID Endpoints: Summary

All EUID endpoints require a client secret for encrypting API requests (except POST /token/refresh requests) and decrypting responses. For details, and code examples in different programming languages, see Encrypting Requests and Decrypting Responses.

EUID Tokens

The following endpoints are for retrieving and managing EUID tokens (identity tokens, advertising tokens), and are used mainly by publishers.

Endpoint	Description	Request Encryption	Response Decryption
POST /token/generate	Requests an EUID token generated from a user's personal data (email address or phone number). If the personal data is valid, and the user has not opted out of EUID, this operation returns an EUID token and associated values.	Required	Required
POST /token/validate	Used for testing, to validate that an advertising token (EUID) matches the specified email address, phone number, or the respective hash.	Required	Required
POST /token/refresh	Generates a new token for a user for their refresh token from the POST /token/generate response.	N/A	Required

The following endpoints are used by advertisers and third-party data providers. Publishers do not need to use these endpoints.

Endpoint	Description	Request Encryption	Response Decryption
POST /identity/buckets	Monitors rotated salt buckets using their last updated timestamp.	Required	Required
POST /identity/map	Retrieves raw EUIDs and salt bucket IDs for one or more email addresses, phone numbers, or their respective hashes.	Required	Required

The following endpoint can be used by advertisers, third-party data providers, and DSPs. Publishers do not need to use this endpoint.

For details about the EUID opt-out workflow and how users can opt out, see User Opt-Out.

Endpoint	Description	Request Encryption	Response Decryption
POST /optout/status	Checks the opt-out status of raw EUIDs. This endpoint takes a list of raw EUIDs as input, and returns the raw EUIDs that have opted out, as well as the time that the opt-out took place.	Required	Required