Documentation Index

Fetch the complete documentation index at: https://academy.insiderone.com/llms.txt

Use this file to discover all available pages before exploring further.

Set Data Processing Consent for App Users

Prev Next

The EU’s General Data Protection Regulation came into force on May 25, 2018. This legislation requires customers to obtain specific consent before sending their data to Insider as the Data Processor. The Data Processing Consent API helps you send user consent programmatically and in real time via predefined web services.

Endpoint and headers

POST https://mobile.useinsider.com/api/v1/privacy/gdpr/consent/set

Visit our Postman collection to test this request.

Headers

Header

Sample Value

Description

Content-Type

application/json

This header specifies the media type of the resource.

Body parameters

Parameter

Description

Data Type

Required

partner_name

Your Insider One partner name. The partner name should be lowercase.

String

Yes

gdpr_consent

If consent is given, true
Otherwise false

Boolean

Yes

target

The object that contains the user's unique device ID and its value. E.g. "udid": "1234"

Object

Yes

Sample body

The sample below shows a request to send user consent information via the Data Processing Consent API, as required under the EU’s GDPR (effective May 25, 2018).

{
    "partner_name": "Your partner name goes here",
    "gdpr_consent": true,
    "target": {
        "udid": "1A2B3C4D5E6F7X8Y9Z"
    }
}

Sample responses

200 OK

The following response returns if the request is successful.

{
    "status": "ok"
}

400 Bad Request

The following response returns if the partner_name or target is empty in the request.

Bad Payload.

Limitations

  • All functions must be executed with a simple HTTPS POST request.

  • The partner name should be provided in the request body. If the value is incorrect, no operation will be executed.

  • Each request can set data processing consent for only one UDID.

  • The value of partner_name should be lowercase.