Retrieving envelopes - identified

get

https://api.rlcdn.com/api/identity/v2/envelope

Retrieve envelopes using (hashed) identifiers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Server-to-Server Integrations

When retrieving or refreshing the ATS Envelopes, publishers integrating server-to-server are required to include the X-Forwarded-For header to ensure that the client-side IP address is within the approved countries tied to the ATS Placement.

Query Params

pid

int32

Defaults to 14

Your LiveRamp-provided Placement ID

int32

Defaults to 4

The identifier type of the call. Add "4" for hashed emails, "11" for phone number hashes (U.S. only), or "15" for Custom IDs. See "About Custom IDs" below to learn more.

string

Defaults to 38CFDA7F9B55B7F74B6D3D143CBB7661DA9BFEB4683473A5813B220A571A1E37

The hashed version of a raw email or phone number. In this example we used the SHA256 hash of the raw email; [email protected]. For custom IDs, add following value within the iv parameter: ANA_ID:CUSTOM_ID.

gpp_sid

string

Defaults to 7

The valid corresponding GPP section ID.

int32

Defaults to 4

The type of consent passed to the API. "3" is a CCPA US Privacy String (optional) and "4" represents a TCFv2 compatible string. Consent is required for processing in the EU/EEA.

string

Defaults to CPUCbs9PUDXghADABCENCBCoAP_AAEJAAAAADGwBAAGABPADCAY0BjYAgADAAngBhAMaAAA.YAAAAAAAA4AA

The consent string value for TCF v2 and CCPA.

gpp

string

Defaults to DBABLA~BVQqAAAAAAA

The GPP consent string value.

atype

string

Defaults to 2

The ATS implementation method to determine the source of the call. "2" represents ATS API.

Headers

Origin

string

Defaults to https://example.com

An origin domain that was included in the privacy review for the Placement ID you're using

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Server-to-Server Integrations

200200

204204

400400

401401

403403

451451