Concepts
Open Gateway will reuse many terms that are part of the Consumer Data Standards - this is a key resource to be familiar with.
When integrating with Open Gateway (OG) the following concepts are important to understand.
What is a principal
A principal generally relates to a user of the system, but this not always the case where consumers are acting as business representatives.
What is an Agreement
An agreement relates to 1 or CDR Arrangements or consents. They include:
- Use Consent
- Collection Consent
- Direct Marketing Consent
- Redundant Data Consent
Over time, this may also include multiple of these. The agreement will also provide consent for the lifecycle of those consents, where they can be modified as well as withdrawn. An Agreement is what you can query to understand the state of the above.
These are strictly accessible to only a single principal.
What is an Agreement Template
This concept is a range of settings that allow an integration to control aspects of the consumer consent flow. These are, but not limited to:
- Use Consent Purpose
- Collect Consent Purpose
- Sharing Duration
- Data Scopes required
- Restriction on callback domains
- Filtering by industry of data holders
What is Priming an Agreement
Priming refers to the establishing of a workflow to ask a consumer for consent. This provides a unique id for this agreement and allows of OG to then prompt the user for this consent.
This activity is used into two main scenarios:
- To create consent
- To modify the consent
How is CDR Data accessed
The Open Gateway API is largely based on the public data APIs specification published by the DSB. We have made only minor changes to include references to some of our key identifiers. The entities in the responses will be familiar to those that have seen the public specification.
Data currency
OG does not store or cache data returned from its APIs. Where this is not the case, an indication will be made in the endpoint documentation. CDR Data calls are made synchronously with corresponding calls made to OG.