The Identity Envelope Decryption endpoint decrypts an identity envelope to extract a RampID and its associated metadata, then re-encrypts the information with a partner-specific encryption key and partner ID. The result is a RampID in the partner ID space that is usable for transactions.

There is a limitation to the type of data the API can decrypt from. The data represented in the envelopes must correspond to a valid RampID. The cookie and mobile ID data types are not currently supported.

Envelope Decryption Call

The API supports envelope lookups on Person-based identifiers. As the name implies, the input envelope must represent an individual in the underlying data, namely, with granularity of "X" (meaning INDIVIDUAL).

This endpoint supports POST operations with an envelope string passed in as a query parameter. The standard API parameters for the lookup endpoint are also applicable.

The URI path is:

/people/envelope?key=_\<envelope_string_representing_individual>_

The API returns the 200 status code to indicate a successful execution. The resulting decrypted RampID is made available in the anonymousConsumerLink attribute in the "anonymousAbilitec" bundle.

📘

Pseudonymous identifier

In the context of the RampID API, references to "anonymousAbilitec" indicate resolving to people-based pseudonymous online identifiers. For more information, see "RampID Methodology" in the Identity documentation.

Unsuccessful responses from the endpoint may return status codes of 400 (bad request), 404 (not found) or 500 (server error). For more information, see "Errors and Troubleshooting".

Sample Requests and Responses

The following sample requests assume a valid access token is obtained and passed in the Authorization header.

Batch Calls

You can transcode up to 1000 envelopes at a time using the same batch call, which is a POST call to https://us.identity.api.liveramp.com/batch/lookup with JSON in the following format:

[
  "/people/envelope/?key=AUGGsYEKVWxnDsHU6b65TfdHEmC0vY51YrJhxTTRtB54A5dTzdrLIQ", 
  "/people/envelope/?key=AUGFOIZ5kDgv1weSzQ7NXo8sOMraa4ORJJONSoutNa3jb65Rgmj7aE", 
 . . .
]

The corresponding response is formatted similar to the following:

{
  "person": {
    "anonymousAbilitec": {
      "anonymousConsumerLink": "XiT001sgRRky74xZ6NrpSsF6z2ucg6TeV8rISolIhOMe-R94lh47QP2xuVITxFm6otlyrB"
    }
  }
}{
  "person": {
    "anonymousAbilitec": {
      "anonymousConsumerLink": "XiT001xuVITx94lh47QP2xuVITxFmyrBF6z2ucg6TeV8rIe-R94lh47Qh47QP2xrIhz2u"
    }
  }
}

Decrypting a Singular Envelope to a RampID

Sample request:

curl --header "Authorization: Bearer <ACCESS_TOKEN>" 'https://us.identity.api.liveramp.com/people/envelope?key=AUGGsYEKVWxnDsHU6b65TfdHEmC0vY51YrJhxTTRtB54A5dTzdrLIQ'

Sample response with derived RampID output:

{
  "person": {
    "anonymousAbilitec": {
      "anonymousConsumerLink": "XiT001sgRRky74xZ6NrpSsF6z2ucg6TeV8rISolIhOMe-R94lh47QP2xuVITxFm6otlyrB"
    }
  }
}

Errors and Troubleshooting

In addition to error codes listed in Error documents, the envelope decryption endpoint may return the following errors: