Sign in

Permission request schema

Requests

This section specifies the request section of the schema for permission requests

Field Type Description Comments
purposes JSON object A JSON object defining the purposes, data items and third parties structure the user giving permission to  

This section specifies the purposes section of the schema for permission requests

Field Type Description Comments
referenceId string The internal identifier your service has for this item.
purposeId string The internal ID for this purpose
dataGroups JSON object A list of data objects linked to this purpose See own schema for this section below
processors JSON object An array of JSON objects containing the parties that are processors of personal data related to this processing purpose and the status for each. Can be empty. See own schema for this section below
recipients JSON object An array of JSON objects containing the parties that are recipients of personal data related to this processing purpose and the status for each. Can be empty. See own schema for this section below
version string Version of this purpose
status string The permission status for this purpose. Allowed values: approved & denied Important:
A denied permission on the purpose will affect all data items and parties belonging to this purpose

This section specifies the dataGroups part of the schema

Field Type Description Comments
dataGroupId string The internal ID for this data group
referenceId string The internal identifier your service has for this data group.
status string The permission status for this data group. Allowed values: approved & denied  

This section specifies the processors and recipients part of the schema

Field Type Description Comments
partyId string The internal ID for this party
referenceId string The internal identifier your service has for this party.
status string The permission status for this party. Allowed values: approved & denied  

Example payload (from client to DPS)

POST /privacy/v2/projects/{project_id}/permissions

{
  "identityId": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
  "requested": "2017-01-13T01:13:42.042+01:00",
  "meta": {
    "requestedBy": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
    "context": {
      "internalReference": "{ \"initiatedBy\": \"userName\" }",
      "collectionMethod": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
      "application": "fda8ec3d-3260-44c9-8f84-e15a418dfa05"
      "language": "en-AU",
    }
  },
  "request": {
    "purposes": [
      {
        "version": "1.2.0",
        "purposeId": "9d5df04e-3e7c-46a5-9440-8114206dcb52",
        "status": "approved",
        "dataGroups": [
          {
            "dataGroupId": "11d58537-ade6-4019-a9a5-351233a90712",
            "status": "approved"
          }
        ],
        "processors": [
          {
            "status": "approved",
            "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
          }
        ],
        "recipients": [
          {
            "status": "approved",
            "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
          }
        ]
      }
    ]
  }
}
GET /privacy/v2/projects/{project_id}/permissions/{request_id}

{
  "identityId": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
  "requested": "2017-01-13T01:13:42.042+01:00",
  "meta": {
    "requestedBy": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
    "context": {
      "internalReference": "{ \"initiatedBy\": \"userName\" }",
      "collectionMethod": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
      "application": "fda8ec3d-3260-44c9-8f84-e15a418dfa05"
      "language": "en-AU",
    }
  },
  "request": {
    "purposes": [
      {
        "version": "1.2.0",
        "purposeId": "9d5df04e-3e7c-46a5-9440-8114206dcb52",
        "status": "approved",
        "dataGroups": [
          {
            "dataGroupId": "11d58537-ade6-4019-a9a5-351233a90712",
            "status": "approved"
          }
        ],
        "processors": [
          {
            "status": "approved",
            "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
          }
        ],
        "recipients": [
          {
            "status": "approved",
            "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
          }
        ]
      }
    ]
  }
}

Responses

This section specifies the response section of the schema for permission requests

Field Type Description Comments
permissionStatus string The status of the permission. Defaults to completed.