Retrieving Envelopes - Identified

get

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

Retrieve envelopes using (hashed) identifiers.

About Custom IDs

In order to use a custom, publisher-provided identifier within ATS, you will need to send LiveRamp a mapping file on a regular basis. See Custom ID Support to learn more.

When using custom ids you must pass the following values within the iv parameter:
ANA_ID:CUSTOM_ID
Where the ANA_ID represents the Account ID and CUSTOM_ID represents your custom identifier.

Query Params

pid

int32

Defaults to 9999

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.

int32

Defaults to 4

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

string

Defaults to CPUCbs9PUDXghADABCENCBCoAP_AAEJAAAAADGwBAAGABPADCAY0BjYAgADAAngBhAMaAAA.YAAAAAAAA4AA

The relevant consent string value.

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

About Custom IDs

200200

204204

400400

401401

403403