Versions Compared

Version Old Version 6 New Version 7
Changes made by

CBB Admin

CBB Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note, the OBEventNotification object is aligned with the Security Event Token (https://tools.ietf.org/html/rfc8417). It acts as a wrapper for events contained within the events claim

 

...

3.1.1        UML Diagram

...

3.1.2        Notes

The rid, rty and rlk claims are prefixed with the OB namespace http://openbanking.org.bh in the data model. The namespace has been removed from the diagram for clarity.

3.1.3        Data Dictionary

Name

Occurence

Occurrence

XPath

Enhanced

Enhabxced Definition

Class

Codes

Pattern

OBEventNotification

OBEventNotification2

 

 

OBEventNotification

 

 

iss

1..1

OBEventNotification/iss

Issuer.

String

 

 

iat

1..1

OBEventNotification/iat

Issued At.

Number

 

 

jti

1..1

OBEventNotification/jti

JWT ID.

String

 

 

aud

1..1

OBEventNotification/aud

Audience.

String

 

sub 

OBEventNotification/sub

String 1..1

OBEventNotification/sub

Subject.

String : URI

 

 

txn

1..1

OBEventNotification/txn

Transaction Identifier.

String

 

 

toe

1..1

OBEventNotification/toe

Time of Event.

Number

 

 

events

1..1

OBEventNotification/events

Events.

OBEvent

 

 

urn:bh:org:cbb_openbanking:events:resource-updateupdate 

0..1

OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:resource-updateupdate 

Resource-Update Event.

OBEventResourceUpdate

 

 

urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update-account-update 

0..1

OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update

An event that indicates an account linked to a consent has move in/out of scope of the consent.

OBEventAccountAccessConsentLinkedAccountUpdate

 

 

urn:bh:org:cbb_openbanking:events:consent-authorization-revokedrevoked 

0..1

OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:consent-authorization-revoked

An event that indicates a consent resource has had its authorisation revoked.

OBEventConsentAuthorizationRevoked

 

 

3.2       OBEventSubject

This section describes the OBEventSubject class which is used in the OBEventResourceUpdate, OBEventConsentAuthorizationRevoked and OBEventAccountAccessConsentLinkedAccountUpdateclasses.

3.2.1        UML Diagram

 

...

3.2.2        Notes

  • The rid, rty and rlk claims are prefixed with the OB namespace http://openbanking.org.bh in the data model. The namespace has been removed from the diagram for clarity.

  • The array of resource links (http://openbanking.org.bh/rlk) must contain links to all supported versions of the resource.

 

3.2.3        Data Dictionary

Name

Occurrence

XPath

Enhanced Definition

Class

Codes

Pattern

OBEventSubject

 

 

 

OBEventSubject

 

 

subject_type

1..1

OBEventSubject/subject_type

Subject type for the updated resource.

String

http://openbanking.org.bh/rid_http://openbanking.org.bh/rty

 

http://openbanking.org.bh/rid

1..1

OBEventSubject/http://openbanking.org.bh/rid

Resource Id for the updated resource.

String

 

 

http://openbanking.org.bh/rty

1..1

OBEventSubject/http://openbanking.org.bh/rty

Resource Type for the updated resource.

String

 

 

http://openbanking.org.bh/rlk

1..n

OBEventSubject/http://openbanking.org.bh/rlk

Resource links to other available versions of the resource.

OBEventSubject/http://openbanking.org.bh/rlk

 

 

version

1..1

OBEventSubject/http://openbanking.org.bh/rlk/version

Resource version.

String

 

 

link

1..1

OBEventSubject/http://openbanking.org.bh/rlk/link

Resource link.

String

 

 

...

This section describes the OBEventResourceUpdate class which is used in the OBEventNotification resource.

3.3.1        UML Diagram

...

 3.3.2        Notes

  • The rid, rty and rlk claims are prefixed with the OB namespace http://openbanking.org.bh in the data model. The namespace has been removed from the diagram for clarity.

  • The array of resource links (http://openbanking.org.bh/rlk) must contain links to all supported versions of the resource.

3.3.3        Data Dictionary

Name

Occurrence

XPath

Enhanced Definition

Class

Codes

Pattern

urn:bh:org:cbb_openbanking:events:resource-update

 

 

An event that indicates a resource has been updated.

OBEventResourceUpdate

 

 

subject

1..1

urn:bh:org:cbb_openbanking:events:resource-update /subject

The subject of the event.

OBEventSubject

 

 

...

 This section describes the OBEventConsentAuthorizationRevoked class which is used in the OBEventNotification resource

3.4.1        UML Diagram

...

3.4.2        Notes

For the OBEventConsentAuthorizationRevoked object:

  • The subject claim must be populated if the Event Notification does not include a urn:bh:org:cbb_openbanking:events:resource-update event

3.4.3        Data Dictionary

 

Name

Occurrence

XPath

Enhanced Definition

Class

Codes

Pattern

urn:bh:org:cbb_openbanking:events:consent-authorization-revoked

 

 

An event that indicates a consent resource has had its authorisation revoked.

OBEventConsentAuthorizationRevoked

 

 

reason

0..1

urn:bh:org:cbb_openbanking:events:consent-authorization-revoked/reason

Reason for the Consent Authorization Revoked event.

String

 

 

subject

0..1

urn:uk:org:openbanking:events:consent-authorization-revoked/subject

The subject of the event.

OBEventSubject

 

 

...

This section describes the OBEventAccountAccessConsentLinkedAccountUpdate class which is used in the OBEventNotification resource.

 

3.5.1        UML Diagram

...

3.5.2        Notes

For the OBEventAccountAccessConsentLinkedAccountUpdate object:

3.5.3        Data Dictionary

Name

Occurrence

XPath

Enhanced Definition

Class

Codes

Pattern

urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update

 

 

An event that indicates an account linked to a consent has move in/out of scope of the consent.

OBEventAccountAccessConsentLinkedAccountUpdate

 

 

reason

0..1

urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update/reason

Reason for the Account Access Consent Linked Account Update event.

String

 

 

subject

1..1

urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update/subject

The subject of the event.

OBEventSubject

 

 

3.6       Event Notification Retry Policy

3.6.1        ASPSP

An ASPSP's Event Notification Retry Policy defines behaviour when an event notification is unacknowledged or the ASPSP receives a 5xx error.

  • An Event Notification Retry Policy must define an Exponential Backoff Policy to calculate the Retry Time Interval.

  • An Event Notification Retry Policy must define the Maximum Number of Retries an ASPSP will make before declaring the TPP Event Notification endpoint unresponsive and ceasing further attempts.

  • An Event Notification Retry Policy must define the Maximum Time Interval for Retries, after which an ASPSP will declare the TPP Event Notification endpoint unresponsive and cease further attempts.

3.6.2        TPP

A TPP may make GET requests for its resources if its /event-notifications endpoint was unavailable for the Maximum Time Interval for Retries, as defined in an ASPSP's Event Notification Retry Policy.

...

4.        Usage Examples

4.1       Send Event Notification - Resource Update

...