Kertos Ingress API (1.1.0)
Download OpenAPI specification:Download
This document describes the Kertos Ingress API for creating Data Subject Requests (DSRs).
This specification follows sematic versioning.
Add new data subject requests (DSR) to your kertos instance.
For creating a DSR you have to describe both the data subject and the requested actions.
Required fields are annotated with *.
Authorizations:
header Parameters
| x-api-key required | any Endpoints of this API are only available when the requests are sent using a company-specific API key.
The API key should be present in the header as |
Request Body schema: application/json
| requested_actions required | Array of strings Items Enum: "access" "delete" An array to allow multiple types of requests to be made |
required | object Information about the data subject |
| received_at required | string <date-time> The date and time (UTC) the request was received in ISO 8601 format (e.g. 2022-07-21T12:49:36.224Z) |
| skip_verification_email required | boolean If the data subject already was identified by the agent, you can skip the E-Mail verification process. If this field is set to false or not present in the request, Kertos will verify the identity of the subject via email verification. |
| channel required | string Enum: "email" "phone" "mail" "fax" "website" "app" "other" The channel by which the data subject request was received (e.g. email, etc.) |
| inquiry | string A general description text for the request |
Responses
Request samples
- Payload
{- "requested_actions": [
- "access",
- "delete"
], - "received_at": "2020-01-01T00:00:00Z",
- "skip_verification_email": false,
- "channel": "phone",
- "data_subject": {
- "email": "john.doe@kertos.io",
- "first_name": "John",
- "last_name": "Doe",
- "subject_type": "customer"
}
}