📘

Closed Beta

Identity Envelope Creation via API is not yet generally available. If you're interesting in participating in the beta test, please contact your LiveRamp representative.

You can use the the Identity Envelope Creation API to create encrypted identity envelopes for RampIDs.

Unsuccessful responses from the endpoint may return status codes of 400 (bad request), 404 (not found) or 500 (server error). See the error codes listed in Error documents for more information.

🚧

Before Using the Identity Envelope Creation API

In order to use this API, a user must be set up with proper credentials and access permissions. A client representative can help with this setup. For making API calls, a user needs to have a client ID and a client secret. For more details, see "Request an Access Token".

Sample Requests and Responses

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

Batch Calls

We strongly recommend that you use batch calls to process multiple RampIDs at one time. The API supports creating 100 to 1000 envelopes in the same batch call.

To do so:

1. Create a JSON file to contain the RampIDs you want envelopes for.
   JSON

   [
     "/people/anonymousAbilitec/XY10053iTrPxPU2SqkcQyP49F0LdrQxdAiKjmSz7jP58s7Nq4",
     "/people/anonymousAbilitec/{RAMPID}",
     …
   ]
   

2. Make a POST call to https://us.am.identity.api.liveramp.com/v1/batch/lookup/:
   cURL

   curl --location --request POST https://us.identity.api.liveramp.com/v1/batch/lookup
   --header "Accept: application/json"
   --header "Content-Type: application/json"
   --header "Authorization: Bearer {VERY LONG TOKEN HERE}"
   --data "[ {JSON DATA HERE} ]"
   

The response should look like:

{
	"person": {
		"envelope": "An4hpBg4NRoupfto61wUIWxMElHDW0Y2gJrn5tavXGJiK4_YJUfkuw"
	}
}

Single Calls

📘

Single Transaction Calls

To make single transaction calls, you need additional permissions from your LiveRamp representative.

You can create an identity envelope for a single RampID by making a POST call to the people/anonymousAbilitec/endpoint and using the RampID as the final argument:

curl --request POST \
     --url https://us.am.identity.api.liveramp.com/people/anonymousAbilitec?key=XY10053iTrPxPU2SqkcQyP49F0LdrQxdAiKjmSz7jP58s7Nq4 

The result should look like this:

{
  "person": {
    "envelope": "An4hpBg4NRoupfto61wUIWxMElHDW0Y2gJrn5tavXGJiK4_YJUfkuw"
  }
}