Skip to main content

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.

EndpointDescriptionRequest EncryptionResponse Decryption
POST /token/generateRequests an EUID token generated from a user's personal data (email address). If the email address is valid, and the user has not opted out of EUID, this operation returns an EUID token and associated values.RequiredRequired
POST /token/validateUsed for testing, to validate that an advertising token (EUID) matches the specified email address or email address hash.RequiredRequired
POST /token/refreshGenerates a new token for a user for their refresh token from the POST /token/generate response.N/ARequired

Identity Maps

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

EndpointDescriptionRequest EncryptionResponse Decryption
POST /identity/bucketsMonitors rotated salt buckets using their last updated timestamp.RequiredRequired
POST /identity/mapRetrieves raw EUIDs and salt bucket IDs for one or more email addresses or email address hashes.RequiredRequired

Opt-Out Status

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

EndpointDescriptionRequest EncryptionResponse Decryption
POST /optout/statusChecks 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.RequiredRequired