API docs by Redocly

CISO Assistant API — Privacy (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

data-breaches

privacy_data_breaches_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
affected_processings
Array of strings <uuid> [ items <uuid > ]
authorities
Array of strings <uuid> [ items <uuid > ]
breach_type
Array of strings
Items Enum: "privacy_alteration" "privacy_destruction" "privacy_loss" "privacy_other" "privacy_unauthorized_access" "privacy_unauthorized_disclosure"
  • privacy_destruction - Destruction
  • privacy_loss - Loss
  • privacy_alteration - Alteration
  • privacy_unauthorized_disclosure - Unauthorized Disclosure
  • privacy_unauthorized_access - Unauthorized Access
  • privacy_other - Other
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

incident
Array of strings <uuid> [ items <uuid > ]
limit
integer

Number of results to return per page.

name
string
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

risk_level
Array of strings
Items Enum: "privacy_high_risk" "privacy_no_risk" "privacy_risk"
  • privacy_no_risk - No Risk
  • privacy_risk - Risk
  • privacy_high_risk - High Risk
search
string

A search term.

status
Array of strings
Items Enum: "privacy_authority_notified" "privacy_closed" "privacy_discovered" "privacy_subjects_notified" "privacy_under_investigation"
  • privacy_discovered - Discovered
  • privacy_under_investigation - Under Investigation
  • privacy_authority_notified - Authority Notified
  • privacy_subjects_notified - Data Subjects Notified
  • privacy_closed - Closed

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

privacy_data_breaches_create

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
discovered_on
required
string <date-time>
breach_type
string (BreachTypeEnum)
Enum: "privacy_destruction" "privacy_loss" "privacy_alteration" "privacy_unauthorized_disclosure" "privacy_unauthorized_access" "privacy_other"
  • privacy_destruction - Destruction
  • privacy_loss - Loss
  • privacy_alteration - Alteration
  • privacy_unauthorized_disclosure - Unauthorized Disclosure
  • privacy_unauthorized_access - Unauthorized Access
  • privacy_other - Other
risk_level
string (RiskLevelEnum)
Enum: "privacy_no_risk" "privacy_risk" "privacy_high_risk"
  • privacy_no_risk - No Risk
  • privacy_risk - Risk
  • privacy_high_risk - High Risk
status
string (StatusA97Enum)
Enum: "privacy_discovered" "privacy_under_investigation" "privacy_authority_notified" "privacy_subjects_notified" "privacy_closed"
  • privacy_discovered - Discovered
  • privacy_under_investigation - Under Investigation
  • privacy_authority_notified - Authority Notified
  • privacy_subjects_notified - Data Subjects Notified
  • privacy_closed - Closed
affected_subjects_count
integer <int64> [ 0 .. 9223372036854776000 ]

Approximate number of affected data subjects

affected_personal_data_count
integer <int64> [ 0 .. 9223372036854776000 ]

Approximate number of affected personal data

authority_notified_on
string or null <date-time>
authority_notification_ref
string <= 255 characters
subjects_notified_on
string or null <date-time>
potential_consequences
string
reference_link
string or null <uri> <= 2048 characters
observation
string
folder
string <uuid>
incident
string or null <uuid>

Link to associated security incident investigation

assigned_to
Array of strings <uuid> [ items <uuid > ]
affected_processings
Array of strings <uuid> [ items <uuid > ]
affected_personal_data
Array of strings <uuid> [ items <uuid > ]
authorities
Array of strings <uuid> [ items <uuid > ]

Regulatory authorities to notify (e.g., CNIL, ICO, etc.)

remediation_measures
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "assigned_to": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "authorities": [
    ],
  • "remediation_measures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "assigned_to": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "authorities": [
    ],
  • "remediation_measures": [
    ]
}

privacy_data_breaches_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Data Breach.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "assigned_to": [
    ],
  • "authorities": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "remediation_measures": [
    ],
  • "incident": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string"
}

privacy_data_breaches_update

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Data Breach.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
discovered_on
required
string <date-time>
breach_type
string (BreachTypeEnum)
Enum: "privacy_destruction" "privacy_loss" "privacy_alteration" "privacy_unauthorized_disclosure" "privacy_unauthorized_access" "privacy_other"
  • privacy_destruction - Destruction
  • privacy_loss - Loss
  • privacy_alteration - Alteration
  • privacy_unauthorized_disclosure - Unauthorized Disclosure
  • privacy_unauthorized_access - Unauthorized Access
  • privacy_other - Other
risk_level
string (RiskLevelEnum)
Enum: "privacy_no_risk" "privacy_risk" "privacy_high_risk"
  • privacy_no_risk - No Risk
  • privacy_risk - Risk
  • privacy_high_risk - High Risk
status
string (StatusA97Enum)
Enum: "privacy_discovered" "privacy_under_investigation" "privacy_authority_notified" "privacy_subjects_notified" "privacy_closed"
  • privacy_discovered - Discovered
  • privacy_under_investigation - Under Investigation
  • privacy_authority_notified - Authority Notified
  • privacy_subjects_notified - Data Subjects Notified
  • privacy_closed - Closed
affected_subjects_count
integer <int64> [ 0 .. 9223372036854776000 ]

Approximate number of affected data subjects

affected_personal_data_count
integer <int64> [ 0 .. 9223372036854776000 ]

Approximate number of affected personal data

authority_notified_on
string or null <date-time>
authority_notification_ref
string <= 255 characters
subjects_notified_on
string or null <date-time>
potential_consequences
string
reference_link
string or null <uri> <= 2048 characters
observation
string
folder
string <uuid>
incident
string or null <uuid>

Link to associated security incident investigation

assigned_to
Array of strings <uuid> [ items <uuid > ]
affected_processings
Array of strings <uuid> [ items <uuid > ]
affected_personal_data
Array of strings <uuid> [ items <uuid > ]
authorities
Array of strings <uuid> [ items <uuid > ]

Regulatory authorities to notify (e.g., CNIL, ICO, etc.)

remediation_measures
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "assigned_to": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "authorities": [
    ],
  • "remediation_measures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "assigned_to": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "authorities": [
    ],
  • "remediation_measures": [
    ]
}

privacy_data_breaches_partial_update

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Data Breach.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
discovered_on
string <date-time>
breach_type
string (BreachTypeEnum)
Enum: "privacy_destruction" "privacy_loss" "privacy_alteration" "privacy_unauthorized_disclosure" "privacy_unauthorized_access" "privacy_other"
  • privacy_destruction - Destruction
  • privacy_loss - Loss
  • privacy_alteration - Alteration
  • privacy_unauthorized_disclosure - Unauthorized Disclosure
  • privacy_unauthorized_access - Unauthorized Access
  • privacy_other - Other
risk_level
string (RiskLevelEnum)
Enum: "privacy_no_risk" "privacy_risk" "privacy_high_risk"
  • privacy_no_risk - No Risk
  • privacy_risk - Risk
  • privacy_high_risk - High Risk
status
string (StatusA97Enum)
Enum: "privacy_discovered" "privacy_under_investigation" "privacy_authority_notified" "privacy_subjects_notified" "privacy_closed"
  • privacy_discovered - Discovered
  • privacy_under_investigation - Under Investigation
  • privacy_authority_notified - Authority Notified
  • privacy_subjects_notified - Data Subjects Notified
  • privacy_closed - Closed
affected_subjects_count
integer <int64> [ 0 .. 9223372036854776000 ]

Approximate number of affected data subjects

affected_personal_data_count
integer <int64> [ 0 .. 9223372036854776000 ]

Approximate number of affected personal data

authority_notified_on
string or null <date-time>
authority_notification_ref
string <= 255 characters
subjects_notified_on
string or null <date-time>
potential_consequences
string
reference_link
string or null <uri> <= 2048 characters
observation
string
folder
string <uuid>
incident
string or null <uuid>

Link to associated security incident investigation

assigned_to
Array of strings <uuid> [ items <uuid > ]
affected_processings
Array of strings <uuid> [ items <uuid > ]
affected_personal_data
Array of strings <uuid> [ items <uuid > ]
authorities
Array of strings <uuid> [ items <uuid > ]

Regulatory authorities to notify (e.g., CNIL, ICO, etc.)

remediation_measures
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "assigned_to": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "authorities": [
    ],
  • "remediation_measures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "discovered_on": "2019-08-24T14:15:22Z",
  • "breach_type": "privacy_destruction",
  • "risk_level": "privacy_no_risk",
  • "status": "privacy_discovered",
  • "affected_subjects_count": 9223372036854776000,
  • "affected_personal_data_count": 9223372036854776000,
  • "authority_notified_on": "2019-08-24T14:15:22Z",
  • "authority_notification_ref": "string",
  • "subjects_notified_on": "2019-08-24T14:15:22Z",
  • "potential_consequences": "string",
  • "reference_link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "assigned_to": [
    ],
  • "affected_processings": [
    ],
  • "affected_personal_data": [
    ],
  • "authorities": [
    ],
  • "remediation_measures": [
    ]
}

privacy_data_breaches_destroy

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Data Breach.

Responses

privacy_data_breaches_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Data Breach.

Responses

privacy_data_breaches_object_retrieve

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Data Breach.

Responses

privacy_data_breaches_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_data_breaches_breach_type_retrieve

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_data_breaches_risk_level_retrieve

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_data_breaches_status_retrieve

API endpoint that allows data breaches to be viewed or edited.

Authorizations:
knoxApiToken

Responses

data-contractors

privacy_data_contractors_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

processing
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

privacy_data_contractors_create

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
relationship_type
required
string (RelationshipTypeEnum)
Enum: "privacy_data_processor" "privacy_sub_processor" "privacy_joint_controller" "privacy_independent_controller" "privacy_other"
  • privacy_data_processor - Data Processor
  • privacy_sub_processor - Sub-processor
  • privacy_joint_controller - Joint Controller
  • privacy_independent_controller - Independent Controller
  • privacy_other - Other Relationship Type
country
required
string (CountryEnum)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "x28"
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia, Plurinational State of
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei Darussalam
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • CV - Cape Verde
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CD - Congo, The Democratic Republic of the
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czech Republic
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • VA - Holy See (Vatican City State)
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran, Islamic Republic of
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KP - Korea, Democratic People's Republic of
  • KR - Korea, Republic of
  • XK - Kosovo
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Lao People's Democratic Republic
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MK - North Macedonia
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia, Federated States of
  • MD - Moldova, Republic of
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestinian Territory, Occupied
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russian Federation
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena, Ascension and Tristan da Cunha
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia and the South Sandwich Islands
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SZ - Swaziland
  • SE - Sweden
  • CH - Switzerland
  • SY - Syrian Arab Republic
  • TW - Taiwan, Province of China
  • TJ - Tajikistan
  • TZ - Tanzania, United Republic of
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • US - United States
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VE - Venezuela, Bolivarian Republic of
  • VN - Viet Nam
  • VG - Virgin Islands, British
  • VI - Virgin Islands, U.S.
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
  • x28 - Other Countries
documentation_link
string <uri> <= 200 characters
processing
required
string <uuid>
entity
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

privacy_data_contractors_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data contractor.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processing": "string",
  • "folder": "string",
  • "entity": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com"
}

privacy_data_contractors_update

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data contractor.

Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
relationship_type
required
string (RelationshipTypeEnum)
Enum: "privacy_data_processor" "privacy_sub_processor" "privacy_joint_controller" "privacy_independent_controller" "privacy_other"
  • privacy_data_processor - Data Processor
  • privacy_sub_processor - Sub-processor
  • privacy_joint_controller - Joint Controller
  • privacy_independent_controller - Independent Controller
  • privacy_other - Other Relationship Type
country
required
string (CountryEnum)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "x28"
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia, Plurinational State of
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei Darussalam
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • CV - Cape Verde
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CD - Congo, The Democratic Republic of the
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czech Republic
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • VA - Holy See (Vatican City State)
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran, Islamic Republic of
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KP - Korea, Democratic People's Republic of
  • KR - Korea, Republic of
  • XK - Kosovo
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Lao People's Democratic Republic
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MK - North Macedonia
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia, Federated States of
  • MD - Moldova, Republic of
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestinian Territory, Occupied
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russian Federation
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena, Ascension and Tristan da Cunha
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia and the South Sandwich Islands
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SZ - Swaziland
  • SE - Sweden
  • CH - Switzerland
  • SY - Syrian Arab Republic
  • TW - Taiwan, Province of China
  • TJ - Tajikistan
  • TZ - Tanzania, United Republic of
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • US - United States
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VE - Venezuela, Bolivarian Republic of
  • VN - Viet Nam
  • VG - Virgin Islands, British
  • VI - Virgin Islands, U.S.
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
  • x28 - Other Countries
documentation_link
string <uri> <= 200 characters
processing
required
string <uuid>
entity
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

privacy_data_contractors_partial_update

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data contractor.

Request Body schema:
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
relationship_type
string (RelationshipTypeEnum)
Enum: "privacy_data_processor" "privacy_sub_processor" "privacy_joint_controller" "privacy_independent_controller" "privacy_other"
  • privacy_data_processor - Data Processor
  • privacy_sub_processor - Sub-processor
  • privacy_joint_controller - Joint Controller
  • privacy_independent_controller - Independent Controller
  • privacy_other - Other Relationship Type
country
string (CountryEnum)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "x28"
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia, Plurinational State of
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei Darussalam
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • CV - Cape Verde
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CD - Congo, The Democratic Republic of the
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czech Republic
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • VA - Holy See (Vatican City State)
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran, Islamic Republic of
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KP - Korea, Democratic People's Republic of
  • KR - Korea, Republic of
  • XK - Kosovo
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Lao People's Democratic Republic
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MK - North Macedonia
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia, Federated States of
  • MD - Moldova, Republic of
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestinian Territory, Occupied
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russian Federation
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena, Ascension and Tristan da Cunha
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia and the South Sandwich Islands
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SZ - Swaziland
  • SE - Sweden
  • CH - Switzerland
  • SY - Syrian Arab Republic
  • TW - Taiwan, Province of China
  • TJ - Tajikistan
  • TZ - Tanzania, United Republic of
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • US - United States
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VE - Venezuela, Bolivarian Republic of
  • VN - Viet Nam
  • VG - Virgin Islands, British
  • VI - Virgin Islands, U.S.
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
  • x28 - Other Countries
documentation_link
string <uri> <= 200 characters
processing
string <uuid>
entity
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "relationship_type": "privacy_data_processor",
  • "country": "AF",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

privacy_data_contractors_destroy

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data contractor.

Responses

privacy_data_contractors_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data contractor.

Responses

privacy_data_contractors_object_retrieve

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data contractor.

Responses

privacy_data_contractors_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_data_contractors_country_retrieve

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_data_contractors_relationship_type_retrieve

API endpoint that allows data contractors to be viewed or edited.

Authorizations:
knoxApiToken

Responses

data-recipients

privacy_data_recipients_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

processing
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

privacy_data_recipients_create

API endpoint that allows data recipients to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
required
string (Category6f1Enum)
Enum: "privacy_internal_team" "privacy_employee" "privacy_subsidiary" "privacy_parent_company" "privacy_affiliated_entity" "privacy_service_provider" "privacy_data_processor" "privacy_cloud_provider" "privacy_it_provider" "privacy_marketing_agency" "privacy_payment_processor" "privacy_analytics_provider" "privacy_business_partner" "privacy_distributor" "privacy_reseller" "privacy_supplier" "privacy_contractor" "privacy_legal_advisor" "privacy_accountant" "privacy_consultant" "privacy_auditor" "privacy_regulatory_authority" "privacy_tax_authority" "privacy_law_enforcement" "privacy_government_entity" "privacy_court" "privacy_joint_controller" "privacy_individual_recipient" "privacy_public" "privacy_other"
  • privacy_internal_team - Internal Team/Department
  • privacy_employee - Employee
  • privacy_subsidiary - Subsidiary Company
  • privacy_parent_company - Parent Company
  • privacy_affiliated_entity - Affiliated Entity
  • privacy_service_provider - Service Provider
  • privacy_data_processor - Data Processor
  • privacy_cloud_provider - Cloud Service Provider
  • privacy_it_provider - IT Service Provider
  • privacy_marketing_agency - Marketing Agency
  • privacy_payment_processor - Payment Processor
  • privacy_analytics_provider - Analytics Provider
  • privacy_business_partner - Business Partner
  • privacy_distributor - Distributor
  • privacy_reseller - Reseller
  • privacy_supplier - Supplier
  • privacy_contractor - Contractor
  • privacy_legal_advisor - Legal Advisor
  • privacy_accountant - Accountant
  • privacy_consultant - Consultant
  • privacy_auditor - Auditor
  • privacy_regulatory_authority - Regulatory Authority
  • privacy_tax_authority - Tax Authority
  • privacy_law_enforcement - Law Enforcement
  • privacy_government_entity - Government Entity
  • privacy_court - Court
  • privacy_joint_controller - Joint Controller
  • privacy_individual_recipient - Individual Recipient
  • privacy_public - Public Disclosure
  • privacy_other - Other Recipient Category
processing
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_data_recipients_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data recipient.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processing": "string",
  • "folder": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team"
}

privacy_data_recipients_update

API endpoint that allows data recipients to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data recipient.

Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
required
string (Category6f1Enum)
Enum: "privacy_internal_team" "privacy_employee" "privacy_subsidiary" "privacy_parent_company" "privacy_affiliated_entity" "privacy_service_provider" "privacy_data_processor" "privacy_cloud_provider" "privacy_it_provider" "privacy_marketing_agency" "privacy_payment_processor" "privacy_analytics_provider" "privacy_business_partner" "privacy_distributor" "privacy_reseller" "privacy_supplier" "privacy_contractor" "privacy_legal_advisor" "privacy_accountant" "privacy_consultant" "privacy_auditor" "privacy_regulatory_authority" "privacy_tax_authority" "privacy_law_enforcement" "privacy_government_entity" "privacy_court" "privacy_joint_controller" "privacy_individual_recipient" "privacy_public" "privacy_other"
  • privacy_internal_team - Internal Team/Department
  • privacy_employee - Employee
  • privacy_subsidiary - Subsidiary Company
  • privacy_parent_company - Parent Company
  • privacy_affiliated_entity - Affiliated Entity
  • privacy_service_provider - Service Provider
  • privacy_data_processor - Data Processor
  • privacy_cloud_provider - Cloud Service Provider
  • privacy_it_provider - IT Service Provider
  • privacy_marketing_agency - Marketing Agency
  • privacy_payment_processor - Payment Processor
  • privacy_analytics_provider - Analytics Provider
  • privacy_business_partner - Business Partner
  • privacy_distributor - Distributor
  • privacy_reseller - Reseller
  • privacy_supplier - Supplier
  • privacy_contractor - Contractor
  • privacy_legal_advisor - Legal Advisor
  • privacy_accountant - Accountant
  • privacy_consultant - Consultant
  • privacy_auditor - Auditor
  • privacy_regulatory_authority - Regulatory Authority
  • privacy_tax_authority - Tax Authority
  • privacy_law_enforcement - Law Enforcement
  • privacy_government_entity - Government Entity
  • privacy_court - Court
  • privacy_joint_controller - Joint Controller
  • privacy_individual_recipient - Individual Recipient
  • privacy_public - Public Disclosure
  • privacy_other - Other Recipient Category
processing
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_data_recipients_partial_update

API endpoint that allows data recipients to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data recipient.

Request Body schema:
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
string (Category6f1Enum)
Enum: "privacy_internal_team" "privacy_employee" "privacy_subsidiary" "privacy_parent_company" "privacy_affiliated_entity" "privacy_service_provider" "privacy_data_processor" "privacy_cloud_provider" "privacy_it_provider" "privacy_marketing_agency" "privacy_payment_processor" "privacy_analytics_provider" "privacy_business_partner" "privacy_distributor" "privacy_reseller" "privacy_supplier" "privacy_contractor" "privacy_legal_advisor" "privacy_accountant" "privacy_consultant" "privacy_auditor" "privacy_regulatory_authority" "privacy_tax_authority" "privacy_law_enforcement" "privacy_government_entity" "privacy_court" "privacy_joint_controller" "privacy_individual_recipient" "privacy_public" "privacy_other"
  • privacy_internal_team - Internal Team/Department
  • privacy_employee - Employee
  • privacy_subsidiary - Subsidiary Company
  • privacy_parent_company - Parent Company
  • privacy_affiliated_entity - Affiliated Entity
  • privacy_service_provider - Service Provider
  • privacy_data_processor - Data Processor
  • privacy_cloud_provider - Cloud Service Provider
  • privacy_it_provider - IT Service Provider
  • privacy_marketing_agency - Marketing Agency
  • privacy_payment_processor - Payment Processor
  • privacy_analytics_provider - Analytics Provider
  • privacy_business_partner - Business Partner
  • privacy_distributor - Distributor
  • privacy_reseller - Reseller
  • privacy_supplier - Supplier
  • privacy_contractor - Contractor
  • privacy_legal_advisor - Legal Advisor
  • privacy_accountant - Accountant
  • privacy_consultant - Consultant
  • privacy_auditor - Auditor
  • privacy_regulatory_authority - Regulatory Authority
  • privacy_tax_authority - Tax Authority
  • privacy_law_enforcement - Law Enforcement
  • privacy_government_entity - Government Entity
  • privacy_court - Court
  • privacy_joint_controller - Joint Controller
  • privacy_individual_recipient - Individual Recipient
  • privacy_public - Public Disclosure
  • privacy_other - Other Recipient Category
processing
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_internal_team",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_data_recipients_destroy

API endpoint that allows data recipients to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data recipient.

Responses

privacy_data_recipients_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data recipient.

Responses

privacy_data_recipients_object_retrieve

API endpoint that allows data recipients to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data recipient.

Responses

privacy_data_recipients_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_data_recipients_category_retrieve

API endpoint that allows data recipients to be viewed or edited.

Authorizations:
knoxApiToken

Responses

data-subjects

privacy_data_subjects_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

processing
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

privacy_data_subjects_create

API endpoint that allows data subjects to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
required
string (CategoryE2bEnum)
Enum: "privacy_customer" "privacy_prospect" "privacy_employee" "privacy_job_applicant" "privacy_contractor" "privacy_business_partner" "privacy_user" "privacy_visitor" "privacy_minor" "privacy_vulnerable" "privacy_public" "privacy_other"
  • privacy_customer - Customer/Client
  • privacy_prospect - Prospective Customer/Client
  • privacy_employee - Employee
  • privacy_job_applicant - Job Applicant
  • privacy_contractor - Contractor/Vendor
  • privacy_business_partner - Business Partner
  • privacy_user - Website/App User
  • privacy_visitor - Visitor
  • privacy_minor - Child/Minor
  • privacy_vulnerable - Vulnerable Person
  • privacy_public - General Public
  • privacy_other - Other Data Subject Category
processing
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_data_subjects_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data subject.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processing": "string",
  • "folder": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer"
}

privacy_data_subjects_update

API endpoint that allows data subjects to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data subject.

Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
required
string (CategoryE2bEnum)
Enum: "privacy_customer" "privacy_prospect" "privacy_employee" "privacy_job_applicant" "privacy_contractor" "privacy_business_partner" "privacy_user" "privacy_visitor" "privacy_minor" "privacy_vulnerable" "privacy_public" "privacy_other"
  • privacy_customer - Customer/Client
  • privacy_prospect - Prospective Customer/Client
  • privacy_employee - Employee
  • privacy_job_applicant - Job Applicant
  • privacy_contractor - Contractor/Vendor
  • privacy_business_partner - Business Partner
  • privacy_user - Website/App User
  • privacy_visitor - Visitor
  • privacy_minor - Child/Minor
  • privacy_vulnerable - Vulnerable Person
  • privacy_public - General Public
  • privacy_other - Other Data Subject Category
processing
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_data_subjects_partial_update

API endpoint that allows data subjects to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data subject.

Request Body schema:
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
string (CategoryE2bEnum)
Enum: "privacy_customer" "privacy_prospect" "privacy_employee" "privacy_job_applicant" "privacy_contractor" "privacy_business_partner" "privacy_user" "privacy_visitor" "privacy_minor" "privacy_vulnerable" "privacy_public" "privacy_other"
  • privacy_customer - Customer/Client
  • privacy_prospect - Prospective Customer/Client
  • privacy_employee - Employee
  • privacy_job_applicant - Job Applicant
  • privacy_contractor - Contractor/Vendor
  • privacy_business_partner - Business Partner
  • privacy_user - Website/App User
  • privacy_visitor - Visitor
  • privacy_minor - Child/Minor
  • privacy_vulnerable - Vulnerable Person
  • privacy_public - General Public
  • privacy_other - Other Data Subject Category
processing
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_customer",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_data_subjects_destroy

API endpoint that allows data subjects to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data subject.

Responses

privacy_data_subjects_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data subject.

Responses

privacy_data_subjects_object_retrieve

API endpoint that allows data subjects to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data subject.

Responses

privacy_data_subjects_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_data_subjects_category_retrieve

API endpoint that allows data subjects to be viewed or edited.

Authorizations:
knoxApiToken

Responses

data-transfers

privacy_data_transfers_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

processing
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

transfer_mechanism
Array of strings
Items Enum: "privacy_adequacy_decision" "privacy_appropriate_safeguards" "privacy_binding_corporate_rules" "privacy_certification_mechanisms" "privacy_codes_of_conduct" "privacy_derogation" "privacy_standard_contractual_clauses"
  • privacy_adequacy_decision - Adequacy Decision (Art. 45)
  • privacy_standard_contractual_clauses - Standard Contractual Clauses (Art. 46.2c)
  • privacy_appropriate_safeguards - Appropriate Safeguards (Art. 46)
  • privacy_binding_corporate_rules - Binding Corporate Rules (Art. 47)
  • privacy_codes_of_conduct - Codes of Conduct (Art. 46.2e)
  • privacy_certification_mechanisms - Certification Mechanisms (Art. 46.2f)
  • privacy_derogation - Derogation for Specific Situations (Art. 49)

Responses

Response samples

Content type
application/json
{}

privacy_data_transfers_create

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
country
required
string (CountryEnum)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "x28"
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia, Plurinational State of
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei Darussalam
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • CV - Cape Verde
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CD - Congo, The Democratic Republic of the
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czech Republic
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • VA - Holy See (Vatican City State)
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran, Islamic Republic of
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KP - Korea, Democratic People's Republic of
  • KR - Korea, Republic of
  • XK - Kosovo
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Lao People's Democratic Republic
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MK - North Macedonia
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia, Federated States of
  • MD - Moldova, Republic of
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestinian Territory, Occupied
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russian Federation
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena, Ascension and Tristan da Cunha
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia and the South Sandwich Islands
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SZ - Swaziland
  • SE - Sweden
  • CH - Switzerland
  • SY - Syrian Arab Republic
  • TW - Taiwan, Province of China
  • TJ - Tajikistan
  • TZ - Tanzania, United Republic of
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • US - United States
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VE - Venezuela, Bolivarian Republic of
  • VN - Viet Nam
  • VG - Virgin Islands, British
  • VI - Virgin Islands, U.S.
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
  • x28 - Other Countries
TransferMechanismEnum (string) or BlankEnum (any)
guarantees
string
documentation_link
string <uri> <= 200 characters
processing
required
string <uuid>
entity
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

privacy_data_transfers_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data transfer.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processing": "string",
  • "folder": "string",
  • "entity": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com"
}

privacy_data_transfers_update

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data transfer.

Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
country
required
string (CountryEnum)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "x28"
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia, Plurinational State of
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei Darussalam
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • CV - Cape Verde
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CD - Congo, The Democratic Republic of the
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czech Republic
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • VA - Holy See (Vatican City State)
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran, Islamic Republic of
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KP - Korea, Democratic People's Republic of
  • KR - Korea, Republic of
  • XK - Kosovo
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Lao People's Democratic Republic
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MK - North Macedonia
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia, Federated States of
  • MD - Moldova, Republic of
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestinian Territory, Occupied
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russian Federation
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena, Ascension and Tristan da Cunha
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia and the South Sandwich Islands
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SZ - Swaziland
  • SE - Sweden
  • CH - Switzerland
  • SY - Syrian Arab Republic
  • TW - Taiwan, Province of China
  • TJ - Tajikistan
  • TZ - Tanzania, United Republic of
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • US - United States
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VE - Venezuela, Bolivarian Republic of
  • VN - Viet Nam
  • VG - Virgin Islands, British
  • VI - Virgin Islands, U.S.
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
  • x28 - Other Countries
TransferMechanismEnum (string) or BlankEnum (any)
guarantees
string
documentation_link
string <uri> <= 200 characters
processing
required
string <uuid>
entity
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

privacy_data_transfers_partial_update

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data transfer.

Request Body schema:
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
country
string (CountryEnum)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "x28"
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia, Plurinational State of
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei Darussalam
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • CV - Cape Verde
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CD - Congo, The Democratic Republic of the
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czech Republic
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • VA - Holy See (Vatican City State)
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran, Islamic Republic of
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KP - Korea, Democratic People's Republic of
  • KR - Korea, Republic of
  • XK - Kosovo
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Lao People's Democratic Republic
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MK - North Macedonia
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia, Federated States of
  • MD - Moldova, Republic of
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestinian Territory, Occupied
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russian Federation
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena, Ascension and Tristan da Cunha
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia and the South Sandwich Islands
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SZ - Swaziland
  • SE - Sweden
  • CH - Switzerland
  • SY - Syrian Arab Republic
  • TW - Taiwan, Province of China
  • TJ - Tajikistan
  • TZ - Tanzania, United Republic of
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • US - United States
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VE - Venezuela, Bolivarian Republic of
  • VN - Viet Nam
  • VG - Virgin Islands, British
  • VI - Virgin Islands, U.S.
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
  • x28 - Other Countries
TransferMechanismEnum (string) or BlankEnum (any)
guarantees
string
documentation_link
string <uri> <= 200 characters
processing
string <uuid>
entity
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "country": "AF",
  • "transfer_mechanism": "privacy_adequacy_decision",
  • "guarantees": "string",
  • "documentation_link": "http://example.com",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a"
}

privacy_data_transfers_destroy

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data transfer.

Responses

privacy_data_transfers_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data transfer.

Responses

privacy_data_transfers_object_retrieve

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this data transfer.

Responses

privacy_data_transfers_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_data_transfers_country_retrieve

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_data_transfers_transfer_mechanism_retrieve

API endpoint that allows data transfers to be viewed or edited.

Authorizations:
knoxApiToken

Responses

personal-data

privacy_personal_data_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
assets
Array of strings <uuid> [ items <uuid > ]
category
Array of strings
Items Enum: "privacy_address" "privacy_bank_account" "privacy_basic_identity" "privacy_biometric_data" "privacy_browsing_history" "privacy_communication_metadata" "privacy_contact_details" "privacy_cookies" "privacy_correspondence" "privacy_criminal_records" "privacy_device_information" "privacy_drivers_license" "privacy_education_history" "privacy_email" "privacy_employment_details" "privacy_family_details" "privacy_feedback" "privacy_financial_data" "privacy_genetic_data" "privacy_government_identifiers" "privacy_health_data" "privacy_identification_numbers" "privacy_images_photos" "privacy_ip_address" "privacy_judicial_data" "privacy_legal_records" "privacy_lifestyle_information" "privacy_location_data" "privacy_messaging_content" "privacy_name" "privacy_online_identifiers" "privacy_opinions" "privacy_other" "privacy_passport_information" "privacy_payment_card" "privacy_phone_number" "privacy_political_opinions" "privacy_preferences" "privacy_professional_qualifications" "privacy_racial_ethnic_origin" "privacy_religious_beliefs" "privacy_salary_information" "privacy_search_history" "privacy_sex_life_data" "privacy_sexual_orientation" "privacy_social_network" "privacy_social_security" "privacy_tax_information" "privacy_trade_union_membership" "privacy_transaction_history" "privacy_user_behavior" "privacy_video_recordings" "privacy_voice_recordings" "privacy_work_performance"
  • privacy_basic_identity - Basic Identity Information
  • privacy_name - Name
  • privacy_identification_numbers - Identification Numbers
  • privacy_online_identifiers - Online Identifiers
  • privacy_location_data - Location Data
  • privacy_contact_details - Contact Details
  • privacy_address - Address
  • privacy_email - Email Address
  • privacy_phone_number - Phone Number
  • privacy_financial_data - Financial Data
  • privacy_bank_account - Bank Account Information
  • privacy_payment_card - Payment Card Information
  • privacy_transaction_history - Transaction History
  • privacy_salary_information - Salary Information
  • privacy_health_data - Health Data
  • privacy_genetic_data - Genetic Data
  • privacy_biometric_data - Biometric Data
  • privacy_racial_ethnic_origin - Racial or Ethnic Origin
  • privacy_political_opinions - Political Opinions
  • privacy_religious_beliefs - Religious or Philosophical Beliefs
  • privacy_trade_union_membership - Trade Union Membership
  • privacy_sexual_orientation - Sexual Orientation
  • privacy_sex_life_data - Sex Life Data
  • privacy_browsing_history - Browsing History
  • privacy_search_history - Search History
  • privacy_cookies - Cookies Data
  • privacy_device_information - Device Information
  • privacy_ip_address - IP Address
  • privacy_user_behavior - User Behavior
  • privacy_employment_details - Employment Details
  • privacy_education_history - Education History
  • privacy_professional_qualifications - Professional Qualifications
  • privacy_work_performance - Work Performance Data
  • privacy_family_details - Family Details
  • privacy_social_network - Social Network
  • privacy_lifestyle_information - Lifestyle Information
  • privacy_correspondence - Correspondence Content
  • privacy_messaging_content - Messaging Content
  • privacy_communication_metadata - Communication Metadata
  • privacy_government_identifiers - Government Identifiers
  • privacy_tax_information - Tax Information
  • privacy_social_security - Social Security Information
  • privacy_drivers_license - Driver's License Information
  • privacy_passport_information - Passport Information
  • privacy_legal_records - Legal Records
  • privacy_criminal_records - Criminal Records
  • privacy_judicial_data - Judicial Data
  • privacy_preferences - Preferences
  • privacy_opinions - Opinions
  • privacy_feedback - Feedback
  • privacy_images_photos - Images and Photos
  • privacy_voice_recordings - Voice Recordings
  • privacy_video_recordings - Video Recordings
  • privacy_other - Other Personal Data
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

processing
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

privacy_personal_data_create

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
required
string (CategoryA8aEnum)
Enum: "privacy_basic_identity" "privacy_name" "privacy_identification_numbers" "privacy_online_identifiers" "privacy_location_data" "privacy_contact_details" "privacy_address" "privacy_email" "privacy_phone_number" "privacy_financial_data" "privacy_bank_account" "privacy_payment_card" "privacy_transaction_history" "privacy_salary_information" "privacy_health_data" "privacy_genetic_data" "privacy_biometric_data" "privacy_racial_ethnic_origin" "privacy_political_opinions" "privacy_religious_beliefs" "privacy_trade_union_membership" "privacy_sexual_orientation" "privacy_sex_life_data" "privacy_browsing_history" "privacy_search_history" "privacy_cookies" "privacy_device_information" "privacy_ip_address" "privacy_user_behavior" "privacy_employment_details" "privacy_education_history" "privacy_professional_qualifications" "privacy_work_performance" "privacy_family_details" "privacy_social_network" "privacy_lifestyle_information" "privacy_correspondence" "privacy_messaging_content" "privacy_communication_metadata" "privacy_government_identifiers" "privacy_tax_information" "privacy_social_security" "privacy_drivers_license" "privacy_passport_information" "privacy_legal_records" "privacy_criminal_records" "privacy_judicial_data" "privacy_preferences" "privacy_opinions" "privacy_feedback" "privacy_images_photos" "privacy_voice_recordings" "privacy_video_recordings" "privacy_other"
  • privacy_basic_identity - Basic Identity Information
  • privacy_name - Name
  • privacy_identification_numbers - Identification Numbers
  • privacy_online_identifiers - Online Identifiers
  • privacy_location_data - Location Data
  • privacy_contact_details - Contact Details
  • privacy_address - Address
  • privacy_email - Email Address
  • privacy_phone_number - Phone Number
  • privacy_financial_data - Financial Data
  • privacy_bank_account - Bank Account Information
  • privacy_payment_card - Payment Card Information
  • privacy_transaction_history - Transaction History
  • privacy_salary_information - Salary Information
  • privacy_health_data - Health Data
  • privacy_genetic_data - Genetic Data
  • privacy_biometric_data - Biometric Data
  • privacy_racial_ethnic_origin - Racial or Ethnic Origin
  • privacy_political_opinions - Political Opinions
  • privacy_religious_beliefs - Religious or Philosophical Beliefs
  • privacy_trade_union_membership - Trade Union Membership
  • privacy_sexual_orientation - Sexual Orientation
  • privacy_sex_life_data - Sex Life Data
  • privacy_browsing_history - Browsing History
  • privacy_search_history - Search History
  • privacy_cookies - Cookies Data
  • privacy_device_information - Device Information
  • privacy_ip_address - IP Address
  • privacy_user_behavior - User Behavior
  • privacy_employment_details - Employment Details
  • privacy_education_history - Education History
  • privacy_professional_qualifications - Professional Qualifications
  • privacy_work_performance - Work Performance Data
  • privacy_family_details - Family Details
  • privacy_social_network - Social Network
  • privacy_lifestyle_information - Lifestyle Information
  • privacy_correspondence - Correspondence Content
  • privacy_messaging_content - Messaging Content
  • privacy_communication_metadata - Communication Metadata
  • privacy_government_identifiers - Government Identifiers
  • privacy_tax_information - Tax Information
  • privacy_social_security - Social Security Information
  • privacy_drivers_license - Driver's License Information
  • privacy_passport_information - Passport Information
  • privacy_legal_records - Legal Records
  • privacy_criminal_records - Criminal Records
  • privacy_judicial_data - Judicial Data
  • privacy_preferences - Preferences
  • privacy_opinions - Opinions
  • privacy_feedback - Feedback
  • privacy_images_photos - Images and Photos
  • privacy_voice_recordings - Voice Recordings
  • privacy_video_recordings - Video Recordings
  • privacy_other - Other Personal Data
retention
string <= 255 characters
DeletionPolicyEnum (string) or BlankEnum (any)
is_sensitive
boolean
processing
required
string <uuid>
assets
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true,
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true,
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "assets": [
    ]
}

privacy_personal_data_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this personal data.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processing": "string",
  • "folder": "string",
  • "assets": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true
}

privacy_personal_data_update

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this personal data.

Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
required
string (CategoryA8aEnum)
Enum: "privacy_basic_identity" "privacy_name" "privacy_identification_numbers" "privacy_online_identifiers" "privacy_location_data" "privacy_contact_details" "privacy_address" "privacy_email" "privacy_phone_number" "privacy_financial_data" "privacy_bank_account" "privacy_payment_card" "privacy_transaction_history" "privacy_salary_information" "privacy_health_data" "privacy_genetic_data" "privacy_biometric_data" "privacy_racial_ethnic_origin" "privacy_political_opinions" "privacy_religious_beliefs" "privacy_trade_union_membership" "privacy_sexual_orientation" "privacy_sex_life_data" "privacy_browsing_history" "privacy_search_history" "privacy_cookies" "privacy_device_information" "privacy_ip_address" "privacy_user_behavior" "privacy_employment_details" "privacy_education_history" "privacy_professional_qualifications" "privacy_work_performance" "privacy_family_details" "privacy_social_network" "privacy_lifestyle_information" "privacy_correspondence" "privacy_messaging_content" "privacy_communication_metadata" "privacy_government_identifiers" "privacy_tax_information" "privacy_social_security" "privacy_drivers_license" "privacy_passport_information" "privacy_legal_records" "privacy_criminal_records" "privacy_judicial_data" "privacy_preferences" "privacy_opinions" "privacy_feedback" "privacy_images_photos" "privacy_voice_recordings" "privacy_video_recordings" "privacy_other"
  • privacy_basic_identity - Basic Identity Information
  • privacy_name - Name
  • privacy_identification_numbers - Identification Numbers
  • privacy_online_identifiers - Online Identifiers
  • privacy_location_data - Location Data
  • privacy_contact_details - Contact Details
  • privacy_address - Address
  • privacy_email - Email Address
  • privacy_phone_number - Phone Number
  • privacy_financial_data - Financial Data
  • privacy_bank_account - Bank Account Information
  • privacy_payment_card - Payment Card Information
  • privacy_transaction_history - Transaction History
  • privacy_salary_information - Salary Information
  • privacy_health_data - Health Data
  • privacy_genetic_data - Genetic Data
  • privacy_biometric_data - Biometric Data
  • privacy_racial_ethnic_origin - Racial or Ethnic Origin
  • privacy_political_opinions - Political Opinions
  • privacy_religious_beliefs - Religious or Philosophical Beliefs
  • privacy_trade_union_membership - Trade Union Membership
  • privacy_sexual_orientation - Sexual Orientation
  • privacy_sex_life_data - Sex Life Data
  • privacy_browsing_history - Browsing History
  • privacy_search_history - Search History
  • privacy_cookies - Cookies Data
  • privacy_device_information - Device Information
  • privacy_ip_address - IP Address
  • privacy_user_behavior - User Behavior
  • privacy_employment_details - Employment Details
  • privacy_education_history - Education History
  • privacy_professional_qualifications - Professional Qualifications
  • privacy_work_performance - Work Performance Data
  • privacy_family_details - Family Details
  • privacy_social_network - Social Network
  • privacy_lifestyle_information - Lifestyle Information
  • privacy_correspondence - Correspondence Content
  • privacy_messaging_content - Messaging Content
  • privacy_communication_metadata - Communication Metadata
  • privacy_government_identifiers - Government Identifiers
  • privacy_tax_information - Tax Information
  • privacy_social_security - Social Security Information
  • privacy_drivers_license - Driver's License Information
  • privacy_passport_information - Passport Information
  • privacy_legal_records - Legal Records
  • privacy_criminal_records - Criminal Records
  • privacy_judicial_data - Judicial Data
  • privacy_preferences - Preferences
  • privacy_opinions - Opinions
  • privacy_feedback - Feedback
  • privacy_images_photos - Images and Photos
  • privacy_voice_recordings - Voice Recordings
  • privacy_video_recordings - Video Recordings
  • privacy_other - Other Personal Data
retention
string <= 255 characters
DeletionPolicyEnum (string) or BlankEnum (any)
is_sensitive
boolean
processing
required
string <uuid>
assets
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true,
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true,
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "assets": [
    ]
}

privacy_personal_data_partial_update

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this personal data.

Request Body schema:
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
category
string (CategoryA8aEnum)
Enum: "privacy_basic_identity" "privacy_name" "privacy_identification_numbers" "privacy_online_identifiers" "privacy_location_data" "privacy_contact_details" "privacy_address" "privacy_email" "privacy_phone_number" "privacy_financial_data" "privacy_bank_account" "privacy_payment_card" "privacy_transaction_history" "privacy_salary_information" "privacy_health_data" "privacy_genetic_data" "privacy_biometric_data" "privacy_racial_ethnic_origin" "privacy_political_opinions" "privacy_religious_beliefs" "privacy_trade_union_membership" "privacy_sexual_orientation" "privacy_sex_life_data" "privacy_browsing_history" "privacy_search_history" "privacy_cookies" "privacy_device_information" "privacy_ip_address" "privacy_user_behavior" "privacy_employment_details" "privacy_education_history" "privacy_professional_qualifications" "privacy_work_performance" "privacy_family_details" "privacy_social_network" "privacy_lifestyle_information" "privacy_correspondence" "privacy_messaging_content" "privacy_communication_metadata" "privacy_government_identifiers" "privacy_tax_information" "privacy_social_security" "privacy_drivers_license" "privacy_passport_information" "privacy_legal_records" "privacy_criminal_records" "privacy_judicial_data" "privacy_preferences" "privacy_opinions" "privacy_feedback" "privacy_images_photos" "privacy_voice_recordings" "privacy_video_recordings" "privacy_other"
  • privacy_basic_identity - Basic Identity Information
  • privacy_name - Name
  • privacy_identification_numbers - Identification Numbers
  • privacy_online_identifiers - Online Identifiers
  • privacy_location_data - Location Data
  • privacy_contact_details - Contact Details
  • privacy_address - Address
  • privacy_email - Email Address
  • privacy_phone_number - Phone Number
  • privacy_financial_data - Financial Data
  • privacy_bank_account - Bank Account Information
  • privacy_payment_card - Payment Card Information
  • privacy_transaction_history - Transaction History
  • privacy_salary_information - Salary Information
  • privacy_health_data - Health Data
  • privacy_genetic_data - Genetic Data
  • privacy_biometric_data - Biometric Data
  • privacy_racial_ethnic_origin - Racial or Ethnic Origin
  • privacy_political_opinions - Political Opinions
  • privacy_religious_beliefs - Religious or Philosophical Beliefs
  • privacy_trade_union_membership - Trade Union Membership
  • privacy_sexual_orientation - Sexual Orientation
  • privacy_sex_life_data - Sex Life Data
  • privacy_browsing_history - Browsing History
  • privacy_search_history - Search History
  • privacy_cookies - Cookies Data
  • privacy_device_information - Device Information
  • privacy_ip_address - IP Address
  • privacy_user_behavior - User Behavior
  • privacy_employment_details - Employment Details
  • privacy_education_history - Education History
  • privacy_professional_qualifications - Professional Qualifications
  • privacy_work_performance - Work Performance Data
  • privacy_family_details - Family Details
  • privacy_social_network - Social Network
  • privacy_lifestyle_information - Lifestyle Information
  • privacy_correspondence - Correspondence Content
  • privacy_messaging_content - Messaging Content
  • privacy_communication_metadata - Communication Metadata
  • privacy_government_identifiers - Government Identifiers
  • privacy_tax_information - Tax Information
  • privacy_social_security - Social Security Information
  • privacy_drivers_license - Driver's License Information
  • privacy_passport_information - Passport Information
  • privacy_legal_records - Legal Records
  • privacy_criminal_records - Criminal Records
  • privacy_judicial_data - Judicial Data
  • privacy_preferences - Preferences
  • privacy_opinions - Opinions
  • privacy_feedback - Feedback
  • privacy_images_photos - Images and Photos
  • privacy_voice_recordings - Voice Recordings
  • privacy_video_recordings - Video Recordings
  • privacy_other - Other Personal Data
retention
string <= 255 characters
DeletionPolicyEnum (string) or BlankEnum (any)
is_sensitive
boolean
processing
string <uuid>
assets
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true,
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "category": "privacy_basic_identity",
  • "retention": "string",
  • "deletion_policy": "privacy_automatic_deletion",
  • "is_sensitive": true,
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e",
  • "assets": [
    ]
}

privacy_personal_data_destroy

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this personal data.

Responses

privacy_personal_data_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this personal data.

Responses

privacy_personal_data_object_retrieve

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this personal data.

Responses

privacy_personal_data_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_personal_data_batch_create_create

Batch create multiple personal data entries for a processing. Expected format: { "processing": "uuid", "categories": ["privacy_name", "privacy_email", ...], "retention": "2 years", "deletion_policy": "privacy_automatic_deletion", "is_sensitive": false }

Authorizations:
knoxApiToken

Responses

privacy_personal_data_category_retrieve

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_personal_data_deletion_policy_retrieve

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_personal_data_is_sensitive_retrieve

API endpoint that allows personal data to be viewed or edited.

Authorizations:
knoxApiToken

Responses

processing-natures

privacy_processing_natures_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

privacy_processing_natures_create

Authorizations:
knoxApiToken
Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
default_locale
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

privacy_processing_natures_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Processing Nature.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

privacy_processing_natures_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Processing Nature.

Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
default_locale
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

privacy_processing_natures_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Processing Nature.

Request Body schema:
name
string
description
string or null
annotation
string or null
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
default_locale
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

privacy_processing_natures_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Processing Nature.

Responses

privacy_processing_natures_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Processing Nature.

Responses

privacy_processing_natures_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Processing Nature.

Responses

privacy_processing_natures_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

processings

privacy_processings_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
assigned_to
Array of strings <uuid> [ items <uuid > ]
filtering_labels
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

nature
Array of strings <uuid> [ items <uuid > ]
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

perimeters
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

status
Array of strings
Items Enum: "privacy_approved" "privacy_deprecated" "privacy_draft" "privacy_in_review"
  • privacy_draft - Draft
  • privacy_in_review - In Review
  • privacy_approved - Approved
  • privacy_deprecated - Deprecated

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

privacy_processings_create

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
status
string (Status769Enum)
Enum: "privacy_draft" "privacy_in_review" "privacy_approved" "privacy_deprecated"
  • privacy_draft - Draft
  • privacy_in_review - In Review
  • privacy_approved - Approved
  • privacy_deprecated - Deprecated
information_channel
string <= 255 characters
usage_channel
string <= 255 characters
dpia_required
boolean
dpia_reference
string <= 255 characters
has_sensitive_personal_data
boolean
folder
string <uuid>
author
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
nature
Array of strings <uuid> [ items <uuid > ]
associated_controls
Array of strings <uuid> [ items <uuid > ]
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]
perimeters
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "perimeters": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "perimeters": [
    ]
}

privacy_processings_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this processing.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "purposes": [
    ],
  • "perimeters": [
    ],
  • "validation_flows": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

privacy_processings_update

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this processing.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
status
string (Status769Enum)
Enum: "privacy_draft" "privacy_in_review" "privacy_approved" "privacy_deprecated"
  • privacy_draft - Draft
  • privacy_in_review - In Review
  • privacy_approved - Approved
  • privacy_deprecated - Deprecated
information_channel
string <= 255 characters
usage_channel
string <= 255 characters
dpia_required
boolean
dpia_reference
string <= 255 characters
has_sensitive_personal_data
boolean
folder
string <uuid>
author
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
nature
Array of strings <uuid> [ items <uuid > ]
associated_controls
Array of strings <uuid> [ items <uuid > ]
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]
perimeters
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "perimeters": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "perimeters": [
    ]
}

privacy_processings_partial_update

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this processing.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
status
string (Status769Enum)
Enum: "privacy_draft" "privacy_in_review" "privacy_approved" "privacy_deprecated"
  • privacy_draft - Draft
  • privacy_in_review - In Review
  • privacy_approved - Approved
  • privacy_deprecated - Deprecated
information_channel
string <= 255 characters
usage_channel
string <= 255 characters
dpia_required
boolean
dpia_reference
string <= 255 characters
has_sensitive_personal_data
boolean
folder
string <uuid>
author
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
nature
Array of strings <uuid> [ items <uuid > ]
associated_controls
Array of strings <uuid> [ items <uuid > ]
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]
perimeters
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "perimeters": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "privacy_draft",
  • "information_channel": "string",
  • "usage_channel": "string",
  • "dpia_required": true,
  • "dpia_reference": "string",
  • "has_sensitive_personal_data": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "filtering_labels": [
    ],
  • "nature": [
    ],
  • "associated_controls": [
    ],
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "perimeters": [
    ]
}

privacy_processings_destroy

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this processing.

Responses

privacy_processings_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this processing.

Responses

privacy_processings_object_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this processing.

Responses

privacy_processings_agg_metrics_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

privacy_processings_assigned_to_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

privacy_processings_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_processings_export_csv_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

privacy_processings_export_xlsx_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

privacy_processings_metrics_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

privacy_processings_status_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

purposes

privacy_purposes_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
article_9_condition
Array of strings or null
Items Enum: "privacy_archiving_research" "privacy_employment_social_security" "privacy_explicit_consent" "privacy_legal_claims" "privacy_nonprofit_organization" "privacy_preventive_medicine" "privacy_public_data" "privacy_public_health" "privacy_substantial_public_interest" "privacy_vital_interests_incapacity"
  • privacy_explicit_consent - Explicit Consent for Special Categories
  • privacy_employment_social_security - Employment and Social Security Law
  • privacy_vital_interests_incapacity - Vital Interests (Subject Physically/Legally Incapable)
  • privacy_nonprofit_organization - Processing by Nonprofit Organization
  • privacy_public_data - Data Manifestly Made Public by the Data Subject
  • privacy_legal_claims - Establishment, Exercise or Defense of Legal Claims
  • privacy_substantial_public_interest - Substantial Public Interest
  • privacy_preventive_medicine - Preventive or Occupational Medicine
  • privacy_public_health - Public Health
  • privacy_archiving_research - Archiving, Research or Statistical Purposes
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

legal_basis
Array of strings
Items Enum: "privacy_consent" "privacy_contract" "privacy_legal_obligation" "privacy_legitimate_interests" "privacy_public_interest" "privacy_vital_interests"
  • privacy_consent - Consent
  • privacy_contract - Performance of a Contract
  • privacy_legal_obligation - Compliance with a Legal Obligation
  • privacy_vital_interests - Protection of Vital Interests
  • privacy_public_interest - Performance of a Task in the Public Interest
  • privacy_legitimate_interests - Legitimate Interests
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

processing
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

privacy_purposes_create

API endpoint that allows purposes to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
legal_basis
string (LegalBasisEnum)
Enum: "privacy_consent" "privacy_contract" "privacy_legal_obligation" "privacy_vital_interests" "privacy_public_interest" "privacy_legitimate_interests"
  • privacy_consent - Consent
  • privacy_contract - Performance of a Contract
  • privacy_legal_obligation - Compliance with a Legal Obligation
  • privacy_vital_interests - Protection of Vital Interests
  • privacy_public_interest - Performance of a Task in the Public Interest
  • privacy_legitimate_interests - Legitimate Interests
(Article9ConditionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
processing
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_purposes_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this purpose.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processing": "string",
  • "folder": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent"
}

privacy_purposes_update

API endpoint that allows purposes to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this purpose.

Request Body schema:
required
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
legal_basis
string (LegalBasisEnum)
Enum: "privacy_consent" "privacy_contract" "privacy_legal_obligation" "privacy_vital_interests" "privacy_public_interest" "privacy_legitimate_interests"
  • privacy_consent - Consent
  • privacy_contract - Performance of a Contract
  • privacy_legal_obligation - Compliance with a Legal Obligation
  • privacy_vital_interests - Protection of Vital Interests
  • privacy_public_interest - Performance of a Task in the Public Interest
  • privacy_legitimate_interests - Legitimate Interests
(Article9ConditionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
processing
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_purposes_partial_update

API endpoint that allows purposes to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this purpose.

Request Body schema:
is_published
boolean (Published)
description
string or null
name
string or null <= 200 characters
legal_basis
string (LegalBasisEnum)
Enum: "privacy_consent" "privacy_contract" "privacy_legal_obligation" "privacy_vital_interests" "privacy_public_interest" "privacy_legitimate_interests"
  • privacy_consent - Consent
  • privacy_contract - Performance of a Contract
  • privacy_legal_obligation - Compliance with a Legal Obligation
  • privacy_vital_interests - Protection of Vital Interests
  • privacy_public_interest - Performance of a Task in the Public Interest
  • privacy_legitimate_interests - Legitimate Interests
(Article9ConditionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
processing
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "description": "string",
  • "name": "string",
  • "legal_basis": "privacy_consent",
  • "article_9_condition": "privacy_explicit_consent",
  • "processing": "c43c881f-9ed7-4f12-9609-63bfd77ad44e"
}

privacy_purposes_destroy

API endpoint that allows purposes to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this purpose.

Responses

privacy_purposes_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this purpose.

Responses

privacy_purposes_object_retrieve

API endpoint that allows purposes to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this purpose.

Responses

privacy_purposes_article_9_condition_retrieve

API endpoint that allows purposes to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_purposes_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

right-requests

privacy_right_requests_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

name
string
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

owner
Array of strings <uuid> [ items <uuid > ]
processings
Array of strings <uuid> [ items <uuid > ]
request_type
Array of strings
Items Enum: "access" "deletion" "objection" "other" "portability" "rectification" "restriction"
  • deletion - Deletion / Erasure
  • rectification - Rectification
  • access - Access / Extract
  • portability - Portability
  • restriction - Restriction
  • objection - Objection
  • other - Other
search
string

A search term.

status
Array of strings
Items Enum: "done" "in_progress" "new" "on_hold"
  • new - New
  • in_progress - In Progress
  • on_hold - On hold
  • done - Done

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

privacy_right_requests_create

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
requested_on
required
string <date>
due_date
string or null <date>
request_type
string (RequestTypeEnum)
Enum: "deletion" "rectification" "access" "portability" "restriction" "objection" "other"
  • deletion - Deletion / Erasure
  • rectification - Rectification
  • access - Access / Extract
  • portability - Portability
  • restriction - Restriction
  • objection - Objection
  • other - Other
status
string (Status889Enum)
Enum: "new" "in_progress" "on_hold" "done"
  • new - New
  • in_progress - In Progress
  • on_hold - On hold
  • done - Done
observation
string
folder
string <uuid>
owner
Array of strings <uuid> [ items <uuid > ]
processings
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "owner": [
    ],
  • "processings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "owner": [
    ],
  • "processings": [
    ]
}

privacy_right_requests_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Right Request.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "owner": [
    ],
  • "processings": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string"
}

privacy_right_requests_update

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Right Request.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
requested_on
required
string <date>
due_date
string or null <date>
request_type
string (RequestTypeEnum)
Enum: "deletion" "rectification" "access" "portability" "restriction" "objection" "other"
  • deletion - Deletion / Erasure
  • rectification - Rectification
  • access - Access / Extract
  • portability - Portability
  • restriction - Restriction
  • objection - Objection
  • other - Other
status
string (Status889Enum)
Enum: "new" "in_progress" "on_hold" "done"
  • new - New
  • in_progress - In Progress
  • on_hold - On hold
  • done - Done
observation
string
folder
string <uuid>
owner
Array of strings <uuid> [ items <uuid > ]
processings
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "owner": [
    ],
  • "processings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "owner": [
    ],
  • "processings": [
    ]
}

privacy_right_requests_partial_update

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Right Request.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
requested_on
string <date>
due_date
string or null <date>
request_type
string (RequestTypeEnum)
Enum: "deletion" "rectification" "access" "portability" "restriction" "objection" "other"
  • deletion - Deletion / Erasure
  • rectification - Rectification
  • access - Access / Extract
  • portability - Portability
  • restriction - Restriction
  • objection - Objection
  • other - Other
status
string (Status889Enum)
Enum: "new" "in_progress" "on_hold" "done"
  • new - New
  • in_progress - In Progress
  • on_hold - On hold
  • done - Done
observation
string
folder
string <uuid>
owner
Array of strings <uuid> [ items <uuid > ]
processings
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "owner": [
    ],
  • "processings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "requested_on": "2019-08-24",
  • "due_date": "2019-08-24",
  • "request_type": "deletion",
  • "status": "new",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "owner": [
    ],
  • "processings": [
    ]
}

privacy_right_requests_destroy

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Right Request.

Responses

privacy_right_requests_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Right Request.

Responses

privacy_right_requests_object_retrieve

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Right Request.

Responses

privacy_right_requests_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

privacy_right_requests_owner_retrieve

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_right_requests_request_type_retrieve

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken

Responses

privacy_right_requests_status_retrieve

API endpoint that allows right requests to be viewed or edited.

Authorizations:
knoxApiToken

Responses