Developer Documentation

API Documentation

Last Updated – November 22, 2019

PDF Version can be found here – RIVN API Documentation

 

Add New Deletion Request

POST https://rx.rivn.com/remote_add_requests

cURL Request

curl \ -X POST https://rx.rivn.com/remote_add_requests \ -H “Content-Type: application/json” \ -d ‘{ “account_id”: “{RIVN ACCOUNT ID}”, “api_key” : “{API KEY}”, “{VENDOR ID}”: “{USER IDENTIFIER}” }’ \

 
Example Request
cURL Request
curl \ -X POST https://rx.rivn.com/remote_add_requests \ -H “Content-Type: application/json” \ -d ‘{ “account_id”: “3p0w5DPmts”, “api_key” : “U78iyDQXclwgqe7wtFXAGraFnEk4zi7V”, “PCSEWJPQFP”: “016ed28ae904004d5097e15b126803082001607a00bd0”, “HMEAPCJIKN”: “3030045400548011” }’ \
 
Example Response

{“status”: “success”, “request_id”: “DAQWUGJQPWKXWUP9” } {“status”: “success”, “request_id”: “DAQWUGJQPWKXWUP9”}

Body Parameters

account_id

string

REQUIRED

The account ID for your account.

 

api_key

string

REQUIRED

API key is unique to each account.

{VENDOR ID}

string

The identifier for an individual vendor.

{USER IDENTIFIER}

string

The ID of the user in the third party system.

 

Look Up Status Of Previous Request

POST https://rx.rivn.com/remote_request_status

cURL Request
cURL

curl \ -X POST https://rx.rivn.com/remote_requst_status \ -H “Content-Type: application/json” \ -d ‘{ “account_id”: “{RIVN ACCOUNT ID}”, “api_key” : “{API KEY}” “request_id”: “{REQUEST ID}”, }’ \
Example Request
cURL

curl \ -X POST https://rx.rivn.com/remote_requst_status \ -H “Content-Type: application/json” \ -d ‘{ “account_id”: “3p0w5DPmts”, “api_key” : “U78iyDQXclwgqe7wtFXAGraFnEk4zi7V”, “request_id”: “QAQWUGJQPWKXWUP9”, }’ \

Example Response

{ “vendor”: { “0”: { “status”: “3”, “vendor”: “Heap Analytics”, “request_value”: “3030045400548011”, “vendor_id”: “HMEAPCJIKN”, “date”: “2019-10-04 20:12:56”, } }, “request”: { “date”: “2019-10-04 20:12:56”, “status”: “3”, “method”: “Widget”, “request_id”: “DAQWUGJQPWKXWUP9” } }

 
Body Parameters

account_id

string

REQUIRED

The account ID for your account.

api_key

string

REQUIRED

API key is unique to each account.

request_Id

string

REQUIRED

The request ID that was provided in the response of the original request.

Status: There are multiple values that can be reported as the status.

1

Pending

This is a new request that has not begun processing yet.

2

Working

Processing has begun.

3

Successful

The deletion request was successfully submitted to the vendor.

4

Verified

The end user’s data has been verified to no long be in the vendors data set.

5

Error

There was an error in the request.