Consent Notification API
This API handles the notifications corresponding to the events generated during consent flow i.e. CONSENT-CREATED | CONSENT-REVOKED | CONSENT-PAUSED | CONSENT-RESUMED | CONSENT-EXPIRED The Digitally Signed Consent Artefact may be delivered in the Payload as Base64 encoded data.
Request Parameters
Parameter Name
Data type
Required?
Description
ver
string
Yes
The version of the API. Example : "1.0"
timestamp
string($date-time)
Yes
Creation timestamp of the message which will be updated at each leg
txnid
string
Yes
The unique transaction identifier used for providing an end to end traceability.
Notifier
Information about the notifier
type
string
No
Example : "AA"
id
string
No
Id of the notifying entity as maintained in the AA Ecosystem. Example : "AA_1"
ConsentStatusNotification
Selects a type of Data-flow events , Consent-flow events, and Account discovery flow events
consentId
string
No
Consent Id. XXXX0-XXXX-XXXX
consentStatus
string
No
Status of the Consent. Could be REVOKED, PAUSED, ACTIVE, EXPIRED
Response Parameters
Parameter Name
Data type
Required?
Description
--None--
Example
Sample Request
{
"ver": "1.0",
"timestamp": "2018-12-06T11:39:57.153Z",
"txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
"Notifier": {
"type": "AA",
"id": "AA_1"
},
"ConsentStatusNotification": {
"consentId": "XXXX0-XXXX-XXXX",
"ConsentStatus": "REVOKED"
}
}
Sample Response
200 - OK