Consent

Here are all the new privacy/consent API for new GDPR roles. Here are all api to get users consents permision. In addition to follow GDPR, here are also APIs to get the access for user data and to erasure private data about the customer.

Access private data

The user needs to be logged in to use this endpoint, click here to read more.

API for granting access to customer private data. Due this API will be created workflow case in Connect.

SecurityAuthorization_Code

Request

Request Body schema: application/json

sendReceipt

required

boolean

Says if there is need to send receipt message to customer on email/sms

true: Customer need receipt.
false: Customer does not need receipt.

Responses

200

Response Schema: application/json

success	boolean Status of creating a workflow case in Connect. true: The workflow case was created in Connect. false: The workflow case was not created in Connect.
receiptSend	boolean Status of sending a receipt to the customer for created workflow case in Connect. true: A receipt was sent to the customer. false: The customer did not ask for receipt or an exception has occured.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/privacy/access

Request samples

Response samples

application/json

{"success": true,
"receiptSend": true
}

Remove private data

The user needs to be logged in to use this endpoint, click here to read more.

API to erasure customer private data. Due this API will be created workflow case in Connect.

SecurityAuthorization_Code

Request

Request Body schema: application/json

sendReceipt

required

boolean

Says if there is need to send receipt message to customer on email/sms

true: Customer need receipt.
false: Customer does not need receipt.

Responses

200

Response Schema: application/json

success	boolean Status of creating a workflow case in Connect. true: The workflow case was created in Connect. false: The workflow case was not created in Connect.
receiptSend	boolean Status of sending a receipt to the customer for created workflow case in Connect. true: A receipt was sent to the customer. false: The customer did not ask for receipt or an exception has occured.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/privacy/erasure

Request samples

Response samples

application/json

{"success": true,
"receiptSend": true
}

List consent event history - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

API for getting consents event history to given issuer and subject (subject type).

SecurityClient_Credentials

Request

path Parameters

issuer required	string <= 255 characters Used to identify who has required the consent, ex. name of the company.
subjectType required	string The vaild type of subject is one of these: CONNECT CONNECTID EXTERNAL ORDER Enum: "CONNECT" "CONNECTID" "EXTERNAL" "ORDER"
subject required	string <= 255 characters Identification of the subject: Enter customer number for `subjectType` CONNECT Enter credential for `subjectType` CONNECTID Enter external id for `subjectType` External Enter ConnectID orderid for `subjectType` ORDER.

query Parameters

onlyActive

boolean

Default: true

Whether to return active records or all the data:

true: It returns data only for active records.
false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Identification of the issuer principal of the consent
subject	string <= 255 characters Identification of the subject e.g. customer number or credential
subjectType	string The vaild type of subject is one of these: CONNECT CONNECTID EXTERNAL ORDER Enum: "CONNECT" "CONNECTID" "EXTERNAL" "ORDER"
	Array of objects Consents to given `issuer` and `subject`

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/customer/privacy/consentEvent/history/{issuer}/{subjectType}/{subject}

Request samples

Response samples

application/json

{"issuer": "468979834",
"subject": "563457",
"subjectType": "CONNECT",
"consents": [{"consentId": 1,
"target": "editoral",
"scope": "email",
"events": [{"consentEventId": 1,
"created": 1560963388000,
"source": "Selfservice",
"action": false
},
{"consentEventId": 2,
"created": 1560968512000,
"source": "Selfservice",
"action": true
}
]
}
]
}

List consent text - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

API for getting consent text in additon to consent name and description. Consent text can be get for all issuer consents, for consents of given group or for specyfic consent (by consentId or target and scope).

SecurityClient_Credentials

Request

path Parameters

issuer

required

string <= 255 characters

Identification of the issuer for consent text

query Parameters

consentGroupId	integer If group is specified, only for this group will be consent text returned
consentId	integer That only for this consent will be text returned
target	string <= 255 characters If target is specified for this target will be returned text info
scope	string <= 255 characters In addition to target scope specified consent
onlyActive	boolean Default: true Whether to return active records or all the data: true: It returns data only for active records. false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Identification of the issuer principal of the consent
	Array of objects Consents to given issuer, that has text

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/customer/privacy/consent/text/{issuer}

Request samples

Response samples

application/json

{"issuer": "468979834",
"consents": [{"consentId": 1,
"consentGroupId": 1,
"target": "editoral",
"scope": "email",
"texts": [{"textId": 1,
"languageCode": "nb_NO",
"text": "Samtykker du til å motta eposter?",
"fromDate": 1561932001000
}
]
}
]
}

List consent text history - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

SecurityClient_Credentials

Request

path Parameters

issuer

required

string <= 255 characters

Used to identify who has required the consent, ex. name of the company.

query Parameters

consentGroupId	integer If group is specified, only for this group will be consent text history returned
consentId	integer That only for this consent will be text history returned
target	string <= 255 characters If target is specified for this target will be returned history
scope	string <= 255 characters In addition to target scope specified consent, so `target` & `scope` can identified consent
onlyActive	boolean Default: true Whether to return active records or all the data: true: It returns data only for active records. false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Identification of the issuer principal of the consent
	Array of objects Consents to given `issuer` and `subject`, that has text history

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/customer/privacy/consent/text/history/{issuer}

Request samples

Response samples

application/json

{"issuer": "468979834",
"consents": [{"consentId": 1,
"consentGroupId": 1,
"target": "editoral",
"scope": "email",
"texts": [{"consentTextId": 1,
"languageCode": "nb_NO",
"textHistory": [{"consentTextHistoryId": 1,
"text": "Samtykker du til å motta eposter?",
"fromDate": 1559386588000,
"toDate": 1561892188000
},
{"consentTextHistoryId": 2,
"text": "Samtykker du til å motta epostmeldinger?",
"fromDate": 1561986769000,
"toDate": 1593609208000
}
]
}
]
}
]
}

List consent groups - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

API for getting consent group.

SecurityClient_Credentials

Request

path Parameters

issuer

required

string <= 255 characters

Identification of the issuer principal of the consent.

query Parameters

onlyActive

boolean

Default: true

Whether to return active records or all the data:

true: It returns data only for active records.
false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Used to identify who has required the consent, ex. name of the company.
	Array of objects Used to structure the consents that belongs together based on your choice.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/customer/privacy/consentGroups/{issuer}

Request samples

Response samples

application/json

{"issuer": "468979834",
"groups": [{"consentGroupId": 1,
"created": 1560851788000,
"selectionOrder": 2,
"texts": [{"languageCode": "en_GB",
"name": "Digital Communication",
"description": "Consent for digital communication"
},
{"languageCode": "nb_NO",
"name": "Digital kommunikasjon",
"description": "Samtykke for digital kommunikasjon"
}
],
"active": true
}
]
}

List consent given issuer - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

API for getting consents to given issuer.

SecurityClient_Credentials

Request

path Parameters

issuer

required

string <= 255 characters

Used to identify who has required the consent, ex. name of the company.

query Parameters

consentGroupId	integer If group is specified, only for this group will be consents returned
onlyActive	boolean Default: true Whether to return active records or all the data: true: It returns data only for active records. false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Identification of the issuer principal of the consent
	Array of objects Consents to given issuer

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/customer/privacy/consents/{issuer}

Request samples

Response samples

application/json

{"issuer": "468979834",
"consents": [{"consentId": 1,
"consentGroupId": 1,
"target": "editoral",
"scope": "email",
"parentConsentId": 1,
"selectionOrder": 2,
"displayMode": "A",
"created": 1560855388000,
"texts": [{"languageCode": "nb_NO",
"name": "Kommunikasjon på epost",
"description": "Samtykker du til å motta eposter?"
},
{"languageCode": "en_GB",
"name": "Communication on email",
"description": "Do you agree to recevice emails?"
}
],
"active": true
}
]
}

List consent event history

The user needs to be logged in to use this endpoint, click here to read more.

API for getting consents event history to given issuer and subject (subject type).

SecurityAuthorization_Code

Request

path Parameters

issuer required	string <= 255 characters Used to identify who has required the consent, ex. name of the company
subjectType required	string The vaild type of subject is one of these: CONNECT CONNECTID EXTERNAL ORDER Enum: "CONNECT" "CONNECTID" "EXTERNAL" "ORDER"
subject required	string <= 255 characters Identification of the subject: Enter customer number for `subjectType` CONNECT Enter credential for `subjectType` CONNECTID Enter external id for `subjectType` External Enter ConnectID orderid for `subjectType` ORDER.

query Parameters

onlyActive

boolean

Default: true

Whether to return active records or all the data:

true: It returns data only for active records.
false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Identification of the issuer principal of the consent
subject	string <= 255 characters Identification of the subject e.g. customer number or credential
subjectType	string The vaild type of subject is one of these: CONNECT CONNECTID EXTERNAL ORDER Enum: "CONNECT" "CONNECTID" "EXTERNAL" "ORDER"
	Array of objects Consents to given `issuer` and `subject`

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/privacy/consentEvent/history/{issuer}/{subjectType}/{subject}

Request samples

Response samples

application/json

{"issuer": "468979834",
"subject": "563457",
"subjectType": "CONNECT",
"consents": [{"consentId": 1,
"target": "editoral",
"scope": "email",
"events": [{"consentEventId": 1,
"created": 1560963388000,
"source": "Selfservice",
"action": true
},
{"consentEventId": 2,
"created": 1560963388000,
"source": "Selfservice",
"action": false
}
]
}
]
}

List consent given issuer

The user needs to be logged in to use this endpoint, click here to read more.

API for getting consents to given issuer.

SecurityAuthorization_Code

Request

path Parameters

issuer

required

string <= 255 characters

Used to identify who has required the consent, ex. name of the company.

query Parameters

consentGroupId	integer If group is specified, only for this group will be consents returned.
onlyActive	boolean Default: true Whether to return active records or all the data: true: It returns data only for active records. false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Identification of the issuer principal of the consent
	Array of objects Consents to given issuer

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/privacy/consents/{issuer}

Request samples

Response samples

application/json

{"issuer": "468979834",
"consents": [{"consentId": 1,
"consentGroupId": 1,
"target": "editoral",
"scope": "email",
"parentConsentId": 1,
"selectionOrder": 2,
"displayMode": "A",
"created": 1560855388000,
"texts": [{"languageCode": "nb_NO",
"name": "Kommunikasjon på epost",
"description": "Samtykker du til å motta eposter?"
},
{"languageCode": "en_GB",
"name": "Communication on email",
"description": "Do you agree to recevice emails?"
}
],
"active": true
}
]
}

List consent groups

The user needs to be logged in to use this endpoint, click here to read more.

API for getting consent group.

SecurityAuthorization_Code

Request

path Parameters

issuer

required

string <= 255 characters

Identification of the issuer principal of the consent.

query Parameters

onlyActive

boolean

Default: true

Whether to return active records or all the data:

true: It returns data only for active records.
false: It returns all the data.

Responses

200

Response Schema: application/json

issuer	string <= 255 characters Used to identify who has required the consent, ex. name of the company.
	Array of objects Used to structure the consents that belongs together based on your choice.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/privacy/consentGroups/{issuer}

Request samples

Response samples

application/json

{"issuer": "468979834",
"groups": [{"consentGroupId": 1,
"created": 1560851788000,
"selectionOrder": 2,
"texts": [{"languageCode": "en_GB",
"name": "Digital Communication",
"description": "Consent for digital communication"
},
{"languageCode": "nb_NO",
"name": "Digital kommunikasjon",
"description": "Samtykke for digital kommunikasjon"
}
],
"active": true
}
]
}

Register consent event - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

API for granting consent.

It is required to provide either a consentId, or both target and scope. If all three fields are included, they are required to refer to the same consent.

SecurityClient_Credentials

Request

Request Body schema: application/json

consentId	integer Consent ID for this event - required unless `target` / `scope` is provided
consentTarget	string <= 255 characters Identification of the `target` of the consent (e.g. URL of a policy) - required if none `consentId` is provided
consentScope	string <= 255 characters Scope of the consent. Typically, this will refer to a section or clause in the `target` - required if none `consentId` is provided
subject required	string <= 255 characters Identification of the subject: Enter customer number for `subjectType` CONNECT Enter credential for `subjectType` CONNECTID Enter external id for `subjectType` EXTERNAL Enter ConnectID orderid for `subjectType` ORDER.
subjectType required	string Type of subject, allowed is: CONNECT CONNECTID EXTERNAL ORDER Enum: "CONNECT" "CONNECTID" "EXTERNAL" "ORDER"
source	string <= 255 characters Identification of the source of the consent principal
action required	boolean It informs if the consent is granted. true: The consent is granted. false: The consent is revoked or not granted.
eventTime	integer Time when the consent was given, if different from the current time. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.
data	string <byte> Data documenting the collecting of the consent, base64-encoded.

Responses

200

Response Schema: application/json

consentId	integer Consent ID for this event
subject	string <= 255 characters Identification of the subject e.g. customer number or credential
subjectType	string Type of subject, allowed is: CONNECT CONNECTID EXTERNAL Enum: "CONNECT" "CONNECTID" "EXTERNAL"
consentEventId	integer The ID of this event
created	integer The time this event was saved. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.
source	string <= 255 characters Identification of the source of the consent principal
action	boolean It informs if the consent is granted. true: The consent is granted. false: The consent is revoked or not granted.
	Array of objects If consent has flag followParent set, so all child consent will be also pushed. Here will be list of changed consent/events to main consent/event

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/customer/privacy/consentEvent

Request samples

Response samples

application/json

{"consentId": 1,
"subject": "563457",
"subjectType": "CONNECT",
"consentEventId": 1,
"created": 1560963388000,
"source": "Selfservice",
"action": true,
"childEvents": {"consentEventId": 1,
"consentId": 1,
"created": 1560363712000,
"action": true
}
}

Register consent event

The user needs to be logged in to use this endpoint, click here to read more.

API for granting consent.

It is required to provide either a consentId, or both target and scope. If all three fields are included, they are required to refer to the same consent.

SecurityAuthorization_Code

Request

Request Body schema: application/json

consentId	integer Consent ID for this event - required unless `target` / `scope` is provided
consentTarget	string <= 255 characters Identification of the `target` of the consent (e.g. URL of a policy) - required if none `consentId` is provided
consentScope	string <= 255 characters Scope of the consent. Typically, this will refer to a section or clause in the `target` - required if none `consentId` is provided
subject required	string <= 255 characters Identification of the subject: Enter customer number for `subjectType` CONNECT Enter credential for `subjectType` CONNECTID Enter external id for `subjectType` EXTERNAL Enter ConnectID orderid for `subjectType` ORDER.
subjectType required	string Type of subject, allowed is: CONNECT CONNECTID EXTERNAL ORDER Enum: "CONNECT" "CONNECTID" "EXTERNAL" "ORDER"
source	string <= 255 characters Identification of the source of the consent principal
action required	boolean It informs if the consent is granted. true: The consent is granted. false: The consent is revoked or not granted.
eventTime	integer Time when the consent was given, if different from the current time. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.
data	string <byte> Data documenting the collecting of the consent, base64-encoded.

Responses

200

Response Schema: application/json

consentId	integer Consent ID for this event
subject	string <= 255 characters Identification of the subject e.g. customer number or credential
subjectType	string Type of subject, allowed is: CONNECT CONNECTID EXTERNAL Enum: "CONNECT" "CONNECTID" "EXTERNAL"
consentEventId	integer The ID of this event
created	integer The time this event was saved. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.
source	string <= 255 characters Identification of the source of the consent principal
action	boolean It informs if the consent is granted. true: The consent is granted. false: The consent is revoked or not granted.
	Array of objects If consent has flag followParent set, so all child consent will be also pushed. Here will be list of changed consent/events to main consent/event

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/privacy/consentEvent

Request samples

Response samples

application/json

{"consentId": 1,
"subject": 563457,
"subjectType": "CONNECT",
"consentEventId": "1",
"created": 1560963388000,
"source": "Selfservice",
"action": true,
"childEvents": {"consentEventId": 1,
"consentId": 1,
"created": 1560363712000,
"action": true
}
}

➔ Next to Permission/Shield