Skip to main content

POST /token/generate

Requests an EUID token generated from the email address provided by a user with their authorization for EUID-based targeted advertising. If the email is valid, and the user has not opted out of EUID, this operation returns an EUID token and associated values.

Used by: This endpoint is used mainly by publishers.

IMPORTANT: Be sure to call this endpoint only when you have obtained legal basis to convert the user’s personal data to EUID tokens for targeted advertising. The optout_check parameter, required with a value of 1, checks whether the user has opted out.

Request Format

POST '{environment}/v2/token/generate'

Here's what you need to know about this endpoint requests:

  • To ensure that the API key used to access the service remains secret, EUID tokens must be generated only on the server side after authentication.
  • You must encrypt all requests using your secret. For details and Python script examples, see Encrypting Requests and Decrypting Responses.

Path Parameters

Path ParameterData TypeAttributeDescription
{environment}stringRequiredTesting environment: https://integ.euid.eu
Production environment: https://prod.euid.eu
For a full list, including regional operators, see Environments.

NOTE: The integration environment and the production environment require different API keys.

Unencrypted JSON Body Parameters

IMPORTANT: You must include only one of the following two conditional parameters, plus the required optout_check parameter with a value of 1, as key-value pairs in the JSON body of the request when encrypting it.

Body ParameterData TypeAttributeDescription
emailstringConditionally RequiredThe email address for which to generate tokens.
email_hashstringConditionally RequiredThe Base64-encoded SHA-256 hash of a normalized email address.
tcf_consent_stringstringOptionalThe Transparency and Consent String from the end user whose identity is used to generate the token.
optout_checknumberRequiredChecks whether the user has opted out. Include this parameter with a value of 1.

Request Examples

IMPORTANT: To ensure that the API key used to access the service remains secret, the POST /token/generate endpoint must be called from the server side, unlike the POST /token/refresh, which does not require using an API key.

The following are unencrypted JSON request body examples for each parameter, one of which you should include in your token generation requests:

{
"email": "username@example.com",
"optout_check": 1
}
{
"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=",
"optout_check": 1
}

Here's an encrypted token generation request format with placeholder values:

echo '[Unencrypted-JSON-Request-Body]' \
| encrypt_request.py [CLIENT_SECRET] \
| curl -X POST 'https://prod.euid.eu/v2/token/generate' -H 'Authorization: Bearer [CLIENT_API_KEY]' -d @- \
| decrypt_response.py [CLIENT_SECRET]

Here's an encrypted token generation request example for an email hash:

echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' \
| encrypt_request.py DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow= \
| curl -X POST 'https://prod.euid.eu/v2/token/generate' -H 'Authorization: Bearer YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk=' -d @- \
| decrypt_response.py DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=

For details and Python script examples, see Encrypting Requests and Decrypting Responses.

Decrypted JSON Response Format

note

The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted.

This section includes the following sample responses:

Successful Response

A successful decrypted response returns the user's advertising and refresh tokens for the specified email address or email address hash.

{
"body": {
"advertising_token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b/besPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM+ewMzXXM8G9j8Q=",
"refresh_token": "RefreshToken2F8AAAF2cskumF8AAAF2cskumF8AAAADXwFq/90PYmajV0IPrvo51Biqh7/M+JOuhfBY8KGUn//GsmZr9nf+jIWMUO4diOA92kCTF69JdP71Ooo+yF3V5yy70UDP6punSEGmhf5XSKFzjQssCtlHnKrJwqFGKpJkYA==",
"identity_expires": 1633643601000,
"refresh_from": 1633643001000,
"refresh_expires": 1636322000000,
"refresh_response_key": "wR5t6HKMfJ2r4J7fEGX9Gw=="
},
"status": "success"
}

Optout

Here is an example response when the user has opted out.

{
"status": "optout"
}

Response Body Properties

PropertyData TypeDescription
advertising_tokenstringAn encrypted advertising (EUID) token for the user.
refresh_tokenstringAn encrypted token that can be exchanged with the EUID Service for the latest set of identity tokens.
identity_expiresnumberThe UNIX timestamp (in milliseconds) that indicates when the advertising token expires.
refresh_fromnumberThe UNIX timestamp (in milliseconds) that indicates when the SDK for JavaScript (see SDK for JavaScript Reference Guide) will start refreshing the EUID token.
TIP: If you are not using the SDK, consider refreshing the EUID token from this timestamp, too.
refresh_expiresnumberThe UNIX timestamp (in milliseconds) that indicates when the refresh token expires.
refresh_response_keystringA key to be used in a POST /token/refresh request for response decryption.

Response Status Codes

The following table lists the status property values and their HTTP status code equivalents.

StatusHTTP Status CodeDescription
success200The request was successful. The response will be encrypted.
IMPORTANT: This status may be returned without a generated token.
For example, if the tcf_consent_string parameter value is included, but does not contain sufficient information to generate a token, an insufficient_user_consent message is returned.
optout200The request was successful. Could not generate token because the user has opted out.
client_error400The request had missing or invalid parameters, including an invalid tcf_consent_string value.
unauthorized401The request did not include a bearer token, included an invalid bearer token, or included a bearer token unauthorized to perform the requested operation.

If the status value is anything other than success, the message field provides additional information about the issue.

Test Identities

TypeIdentityPurposeNext Endpoint
Emailvalidate@example.comTest that the advertising_token you've cached matches the advertising_token for the specified email address.POST /token/validate
Emailoptout@example.comUsing this email for the request always generates an optout response.POST /token/generate
Emailrefresh-optout@example.comUsing this email for the request always generates an identity response with a refresh_token that results in an optout response.POST /token/refresh