Mobile Consent

Endpoints

GET /api/mobileconsent/:clientId

[Authentication required]

Get the mobile consent record for a user.

Request:

{
  "MobileApplicationId": "string"
}

Response: 200 OK

{
  "ClientId": "string",
  "CustomUserId": "string",
  "ScreenURI": "string",
  "ConsentGiven": "string",
  "MobileSubConsents": [
    {
      "MobileComplianceCategory": "string",
      "ConsentGiven": "string",
      "MobilePackageConsents": [
        {
          "PackageName": "string",
          "PackageId": "string",
          "IsEnabled": "boolean"
        }
      ]
    }
  ]
}

POST /api/mobileconsent

PUT /api/mobileconsent

Create a new consent or update an existing one if the client ID matches an existing record.

Request:

{
  "ClientId": "string",
  "CustomUserId": "string",
  "ScreenURI": "string",
  "MobileApplicationId": "string",
  "ClientSessionId": "string",
  "DeviceManufacturer": "string",
  "SDKVersion": "string",
  "OSVersion": "string",
  "MobileApplicationId": "string",
  "AllConsents": [
    {
      "MobileComplianceCategory": "string",
      "ConsentGiven": "string",
      "MobilePackageConsents": [
        {
          "PackageName": "string",
          "PackageId": "string",
          "IsEnabled": "boolean"
        }
      ]
    }
  ]
}

Response: 201 Created

PATCH /api/mobileconsent/customuserid/:clientId

[Authentication required]

Update the custom user ID associated with a consent.

Request:

{
  "CustomUserId": "string",
  "MobileApplicationId": "string"
}

Response: 200 OK

{
  "ClientId": "string",
  "CustomUserId": "string",
  "ScreenURI": "string",
  "ConsentGiven": "string",
  "MobileSubConsents": [
    {
      "MobileComplianceCategory": "string",
      "ConsentGiven": "string",
      "MobilePackageConsents": [
        {
          "PackageName": "string",
          "PackageId": "string",
          "IsEnabled": "boolean"
        }
      ]
    }
  ]
}