GDPR / CCPA API

GDPR / CCPA API ensures all the rights of users are created or updated for GDPR / CCPA compliance. You can erase the personal data of specific users as defined under GDPR using the Erase API.

For more details on GDPR Compliance with MoEngage, refer to GDPR-Implementation.

For more details on CCPA Compliance with MoEngage, refer to CCPA-Implementation.

GDPR API Endpoints

MoEngage supports multiple data centers with different dashboards and API endpoints. When you sign up with MoEngage, you will be assigned a particular data center and the relevant dashboard is displayed. Use the API endpoints associated with the data center.

For more information about your data center, contact support@moengage.com.

You can find out which data center you are assigned to when you log in to the dashboard. The following table describes the dashboard URL and API endpoint associated with the data center.

Two versions of the dashboard URL and API endpoints are provided by MoEngage.

Data Centers and API Endpoints

Data Center Name Dashboard URL GDPR
API EndPoint
Data Center 1 (DC-01) http://dashboard-01.moengage.com/ https://api-01.moengage.com/v1/opengdpr_requests/
Data Center 2 (DC-02) http://dashboard-02.moengage.com/ https://api-02.moengage.com/v1/opengdpr_requests/
Data Center 3 (DC-03) http://dashboard-03.moengage.com/ https://api-03.moengage.com/v1/opengdpr_requests/

For more information about MoEngage data centers, refer to Data Centers in MoEngage.

Syntax

JSON

POST [https://api-01.moengage.com/v1/opengdpr_requests/<APP ID>]
POST [https://api-02.moengage.com/v1/opengdpr_requests/<APP ID>]
POST [https://api-03.moengage.com/v1/opengdpr_requests/<APP ID>]
 
 

Required Parameters

app_id
Get the APP ID from the MoEngage dashboard under following path: Settings > App Settings > Account Settings > APP ID.

Required Headers

Authentication

Erase API uses basic authentication to control access to your data.

Basic authentication sends a Base64-encoded string containing username and password for all API requests.

Username and password are available at Settings > APIs > DATA API Settings.

Do the following when you are using the API for the first-time authentication:

  1. Navigate to Settings > APIs > DATA API Settings.
  2. Click Generate Key
  3. Save the details on the Data APIs settings page. User name - DATA API ID Password - DATA API KEY

For example, basic Authentication encodes a 'username:password' using base64 and prepends it with the string 'Basic '. The string is passed in the authorization header as follows:
{"Authorization":"Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U="}

d205ad9-B33zNd8vQFCkugDwITCz_Screen_Shot_2016-06-10_at_6.28.23_pm__1_.png

Authentication is performed using a client like Postman as follows:

f8a047b-postman_new_sample.png

Content-Type Header

The content-Type header is mandatory and is set to 'application/json' as follows:

JSON
{"Content-Type": "application/json"}

Request body

APP ID Header

Get the APP ID from the MoEngage dashboard under the path: Settings > App Settings > Account Settings > APP ID and send in the header as follows:

JSON
{"MOE-APPKEY" :"<APP ID>"}

Request body

There is a max limit of 100kb per request.

Request Body Fields

Key Description Mandatory
request_type This is used to request for GDPR details or request to erase the GDPR details Yes
submitted_time This identifies the time when the request was sent Yes
identities This provides the details of the user such as email address, phone number, and so on Yes
api_version This identifies the API version used to send the GDPR request. Yes
id This is the unique identifier of a registered user. No
user_secondary_id This is the secondary identifier of a registered user. No
email This is the user email of an unregistered user. No
mobile This is the user mobile of an unregistered user. No
google_advertising_id This is the android device GAID of an unregistered user. No
advertising_identifier This is the iOS device IDFA of an unregistered user No

Response

The response is a JSON object.

GDPR request success

On a successful call, the response is as follows:

JSON
{
  "status": "success",
  "message": "Your request has been accepted and will be processed soon.",
  "request_id": "a7551968-d5d6-44b2-9831-815ac9017798"
}

Example

The following example describes the request to erase personal data.

Text
{
 "request_type":"erasure",
 "submitted_time":"2018-10-05T15:00:00Z",
 "identities":[
   {
      "identity_type":"email",
      "identity_value":"johndoe@example.com"
   }
 ],
 "api_version":"1.0"
}

 

Was this article helpful?
0 out of 0 found this helpful