User Privacy API

The User Privacy API allows our partners to prevent certain user data from being processed by their Cortex account. The User Privacy API is used to maintain a list of deleted users. If a user is added to this list, Cortex will not generate predictions or personalized recommendations for the user. This enables you to comply with user privacy requests as outlined by regulations such as the California Consumer Privacy Act (CCPA) and General Data Protection Regulation (GDPR).

All API requests should be made to http://api.vidora.com, using the methods listed below. Note that signatures are required for each of these methods.

List Deleted Users

Returns an array of user IDs for which a deletion request has been made.

Request

Method URL
GET /v1/api/deleted_users

 

Example Request

http://api.vidora.com/v1/api/deleted_users?api_key=<YOUR_KEY>&expires=2020-0101T00%3A00&signature=<YOUR_SIGNATURE>

Example Response

[
    "amme7k5o2qn2f6ax",
    "r4jnbj5m9uj44zbq",
    "i56nt6bkj0yzhtsx",
    "pb88wkmftfj4seyb",
    "t3ua1dy9yo54gmf8"
]

The above example makes a signed call to List Deleted Users in order to retrieve a list of deleted user IDs. The response includes IDs for five deleted users.

Add Deleted Users

Add a user or set of users to the deleted users list. This method involves sending a POST request with the IDs that should be deleted. Note that your POST body needs to be included in the signature generation process.

Request

Method URL
POST /v1/api/deleted_users

 

Params

Param Required? Type Description
user_ids Yes string An array of user IDs that should be added to the deleted users list.

 

Example Request

POST http://api.vidora.com/v1/api/deleted_users?api_key=<YOUR_KEY>&expires=2020-0101T00%3A00&signature=<YOUR_SIGNATURE>

Content-Type: application/json
{ "user_ids": ["qt75k4srvye27ah7", "kp477avzg4szobj5"] }

Example Response

[
    "qt75k4srvye27ah7",
    "kp477avzg4szobj5"
]

The above example makes a signed call to Add Deleted Users in order to add user IDs “qt75k4srvye27ah7” and “kp477avzg4szobj5” to the list of deleted users. The response includes an array of IDs that were added to the list.

Remove Deleted Users

Remove a user from the deleted users list. This method is useful for undoing a deletion request that may have been made by mistake.

Request

Method URL
DELETE /v1/api/deleted_users/<USER_ID>

 

Params

Param Required? Type Description
user_id Yes string A unique ID for the user that should be removed from the deleted users list.

 

Example Request

DELETE http://api.vidora.com/v1/api/deleted_users?api_key=<YOUR_KEY>&expires=2020-0101T00%3A00&signature=<YOUR_SIGNATURE>

The above example makes a signed call to Remove Deleted Users in order to remove user ID “qt75k4srvye27ah7” from the list of deleted users.

Response Codes

Response Description
200 OK The request was successful.
400 Bad Request The request was invalid, possibly due to malformed parameters.
401 Unauthorized The api_key and/or signature was invalid.
404 Not Found The id used in the request was not found or the request URI does not exist.
500 Internal Error There was a server side error, and we cannot serve the request at the current time.

 

Still have questions? Reach out to support@vidora.com for more info!

Table of Contents