Call the Envelope API with the endpoint below. You can also check out our handy API reference page to help you generate the call.
https://api.rlcdn.com/api/identity/envelope?pid=[placement id]&it=[identifier type]&iv=[hashed identifier]&ct=[consent type]&cv=[consent string]
Your Placement ID.
The identifier type of the call:
The hashed version of the raw email or phone number.
When using custom IDs, you must pass the following values within the
The type of consent passed to the API.
The consent string. See Step 2: Provide a Valid Consent String for examples.
An origin domain that was included in the privacy review for the Placement ID you're using.
Provided you have submitted a well-formed query to the ATS Envelope API, two types of "successful" responses are possible.
For opted-in users
You will receive a 200 response for a JSON object with a simple key/value containing the envelope:
For opted-out users (no positive consent signal)
You will receive a 204 response with no content.
See the complete list of status codes below:
No Consent: Opted out user/browser.
Bad Request: Bad Config ID (calling non-existent PID), Unexpected (missing) parameter.
Unauthorized: Origin not allowed (domain was not approved for this Placement ID ).
Forbidden: Endpoint not configured for service.
Unavailable for Legal Reasons: Disallowed country and/or invalid consent string.
Updated 2 months ago