Skip to content

Latest commit

 

History

History
222 lines (203 loc) · 9.22 KB

Correction.md

File metadata and controls

222 lines (203 loc) · 9.22 KB
Raw

Correction

A Correction Request is initiated when a Data Subject invokes a right that allows correction of personal data. Note that only the basic details are transported since collecting specific correction details are currently beyond the scope.

Correction Request

POST /endpoint HTTP/1.1
Host: www.example.com
Content-Type: application/json
Accept: application/json
Authorization: $auth

{
  "apiVersion": "dsr/v1",
  "kind": "CorrectionRequest",
  "metadata": {
    "uid": "22880925-aac5-42f9-a653-cb6921d361ff",
    "tenant": "axonic"
  },
  "request": {
    "controller": "axonic",
    "property": "axonic.io",
    "environment": "production",
    "regulation": "gdpr",
    "jurisdiction": "eugdpr",
    "identities": [
      {
        "identitySpace": "account_id",
        "identityFormat": "raw",
        "identityValue": "123"
      }
    ],
    "callbacks": [
      {
        "url": "https://dsr.ketch.com/callback",
        "headers": {
          "Authorization": "$auth"
        }
      }
    ],
    "subject": {
      "email": "[email protected]",
      "firstName": "Test",
      "lastName": "Subject",
      "addressLine1": "123 Main St",
      "addressLine2": "",
      "city": "Anytown",
      "stateRegionCode": "MA",
      "postalCode": "10123",
      "countryCode": "US",
      "description": "Correct my name to Test Object",
      "formData": {
        "customFormField1": "foo",
        "customFormField2": "bar",
      }
    },
    "context": {
      "contextVar1": "foo",
      "contextVar2": 1,
      "contextVar3": true
    },
    "submittedTimestamp": 123,
    "dueTimestamp": 123
  }
}

Fields

name required? description
apiVersion yes API version. Must be dsr/v1
kind yes Message kind. Must be CorrectionRequest
metadata yes Metadata object
request.controller no Code of the Ketch controller tenant. Only supplied if the ultimate controller is different to the metadata.tenant
request.property yes Code of the digital property defined in Ketch
request.environment yes Code environment defined in Ketch
request.regulation yes Code of the regulation defined in Ketch
request.jurisdiction yes Code of the jurisdiction defined in Ketch
request.identities yes Array of Identities
request.callbacks no Array of Callbacks
request.subject yes The Data Subject
request.context no Map containing additional context (Data Subject Variables) that have been added via identity verification or other augmentation methods
request.submittedTimestamp yes UNIX timestamp in seconds
request.dueTimestamp yes UNIX timestamp in seconds

Correction Response / Status Event

A successful response MUST include the 200 OK response status code and a CorrectionResponse JSON object.

The results and documents are merged with any cached results from previous events. New documents are added and existing documents are updated.

When the status of Correction Request has changed, a CorrectionStatusEvent JSON object should be sent to all the callbacks specified in the request. Once the status is set to completed, then no further events will be accepted.

The Content-Type MUST be application/json.

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "apiVersion": "dsr/v1",
  "kind": "CorrectionResponse",
  "metadata": {
    "uid": "22880925-aac5-42f9-a653-cb6921d361ff",
    "tenant": "axonic"
  },
  "response": {
    "status": "in_progress",
    "resultMessage": "We are processing the request",
    "expectedCompletionTimestamp": 123
    "identities": [
      {
        "identitySpace": "account_id",
        "identityFormat": "raw",
        "identityValue": "123"
      }
    ],
    "subject": {
      "firstName": "Test",
      "lastName": "Subject",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 123",
      "stateRegionCode": "MA",
      "postalCode": "10123",
      "countryCode": "US",
      "formData": {
        "customFormField1": "foo",
        "customFormField2": "bar",
      }
    },
    "context": {
      "contextVar1": "foo",
      "contextVar2": 1,
      "contextVar3": true
    },
    "outcome": {
      "outcomeVar1": "foo",
      "outcomeVar2": 1,
      "outcomeVar3": true
    }
  }
}

Event

POST /callback HTTP/1.1
Host: dsr.ketch.com
Content-Type: application/json
Accept: application/json
Authorization: $auth

{
  "apiVersion": "dsr/v1",
  "kind": "CorrectionStatusEvent",
  "metadata": {
    "uid": "22880925-aac5-42f9-a653-cb6921d361ff",
    "tenant": "axonic"
  },
  "event": {
    "status": "pending",
    "resultMessage": "We are processing the request",
    "expectedCompletionTimestamp": 123,
    "identities": [
      {
        "identitySpace": "account_id",
        "identityFormat": "raw",
        "identityValue": "123"
      }
    ],
    "subject": {
      "firstName": "Test",
      "lastName": "Subject",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 123",
      "stateRegionCode": "MA",
      "postalCode": "10123",
      "countryCode": "US",
      "formData": {
        "customFormField1": "foo",
        "customFormField2": "bar",
      }
    },
    "context": {
      "contextVar1": "foo",
      "contextVar2": 1,
      "contextVar3": true
    },
    "outcome": {
      "outcomeVar1": "foo",
      "outcomeVar2": 1,
      "outcomeVar3": true
    }
  }
}

Fields

name required? description
status yes The [status](Status.md#Status code) of the Data Subject Request
reason no The reason for the status of the Data Subject Request
resultMessage no A user-friendly message specifying any details about the status/response
expectedCompletionTimestamp no The UNIX timestamp at which the Data Subject Request is expected to be completed
requestID no The request ID known to the destination system
results no Array of Documents that can be used to download the contents requested
documents no Array of Documents that can be used to download the contents requested
context no Map containing additions or changes to Data Subject Variables.
redirectUrl no if the Data Subject should be redirected to a URL (perhaps for confirmation)
subject no Map containing additions or changes to subject values Data Subject.
identities no Array of Identities to add to the request
outcome no Map containing additions or changes to Outcome Variables