Introduction
Changelog
Authentication
Headers
Errors
Rate Limiting
Webhooks
CDR
OAuth 2.0
User
Devices
Addresses
Affordability
Aggregation
Bills
Budgets
Cards
Challenges
CDR
Configuration
Contacts
Events
Goals
KYC
Managed Products
Messages
Pay Day
PayID
Payments
Reports
Statements
Surveys
Calculators
Images
Users
Accounts
Transactions
Financial Passport
Status
Outages
Banking
Common

CDR Events

This is a list of all events triggered during the CDR Gateway Consent lifecycle for a user.

Reminder events are triggered at 8AM in the morning by default.

Events

Event Key Event Name Event Description Substitutions
CONSENT_STARTED User Consent has started A consent has been given for a data holder and is now active.

Use to determine when a new consent is added by the user and trigger messaging such as providing the consent confirmation PDF.
PROVIDER_NAME - Name of the Data Holder
START_DATE - Date the consent started
END_DATE - Date the consent is scheduled to expire
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
PERMISSIONS - Array of Permission Cluster keys
CONSENT_STOPPED User Consent has stopped A consent has been withdrawn or expired for a user.

Use to determine when a consent has been withdrawn or expired and trigger messaging such as the consent withdrawn confirmation PDF.
PROVIDER_NAME - Name of the Data Holder
REASON - Reason for consent being stopped; WITHDRAWN or EXPIRED
START_DATE - Date the consent started
END_DATE - Date the consent is scheduled to expire
STOP_DATE - Date the consent stopped
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
CONSENT_SYNC_COMPLETE Consent data has been synced A consent has been added and the data for that consent has been fully synced.

Use to trigger fetching of CDR data such as accounts and transactions as all data should be ready.
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
STATUS - Status of the context sync - SUCCESS or FAILED
PROVIDER_ACCOUNT_IDS - Array of Provider Account IDs related to the Consent
ACCOUNT_IDS - Array of Account IDs synced
CONSENT_SYNC_SUCCESS Consent data sync success A consent has been added and the data for that consent has been successfully synced.

Use to trigger fetching of CDR data such as accounts and transactions as all data should be ready.
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
PROVIDER_ACCOUNT_IDS - Array of Provider Account IDs related to the Consent
ACCOUNT_IDS - Array of Account IDs synced
CONSENT_SYNC_FAILED Consent data sync failed A consent has been added but the initial sync failed. This could be due to a data holder having an outage or another issue.

Use to inform the user of an issue retrieving the data and try again later depending on the reason for failure.
CONSENT_ID - Unique ID of the consents
CONTEXT - Context associated with the Consent
PROVIDER_ACCOUNT_IDS - Array of Provider Account IDs related to the Consent
ACCOUNT_IDS - Array of Account IDs synced if successful
REASON - Indicates the failure reason, SCHEDULED_OUTAGE, FAILURE, UNAVAILABLE
CONTEXT_SYNC_COMPLETE Context consents syncing complete All consents within a context have completed syncing. A status will be returned indicating which consents were successfully synced or not.
Use to initiate data processing or retrieval when all data is required to be synced first.
FAILED_CONSENT_IDS - Array of consent IDs that failed syncing
SUCCESS_CONSENT_IDS - Array of consent IDs that successfully synced
STATUS - Status of the context sync - PARTIAL_SUCCESS, SUCCESS or FAILED
CONTEXT - Context associated with the Consent
PROVIDER_ACCOUNT_IDS - Array of Provider Account IDs related to the Consent
ACCOUNT_IDS - Array of Account IDs synced if successful
CONTEXT_LINKING_COMPLETE Context consents linking process complete Indicates the user has clicked or tapped finished linking from the Frollo Link interface and is no longer linking consents within this context.

Use to determine that a user has completed their actions, however this does not indicate all data has been synced.
CONSENT_IDS - Array of Consent IDs that were linked during the process
CONTEXT - Context associated with the Consent
CONSENT_ONGOING_REMINDER User Consent has been active for 90 days from last notification A reminder that a consent is still active for the user. Triggers every 90 days during a consent lifetime.

Use to inform user of the mandatory consent active reminder.
PROVIDER_NAME - Name of the Data Holder
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
LAST_ACCESSED - Date that data for the consent was last accessed
START_DATE - Date the consent started
END_DATE - Date the consent is scheduled to expire
CONSENT_EXPIRY_FOUR_WEEKS User Consent Expires In Four Weeks Reminder A reminder that a consent is scheduled to expire in four weeks time.

Use to remind a user to renew their consent for continued data access.
PROVIDER_NAME - Name of the Data Holder
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
CONSENT_EXPIRY_TWO_WEEKS User Consent Expires In Two Weeks Reminder A reminder that a consent is scheduled to expire in two weeks time.

Use to remind a user to renew their consent for continued data access.
PROVIDER_NAME - Name of the Data Holder
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
CONSENT_EXPIRY_ONE_WEEK User Consent Expires In One Week Reminder A reminder that a consent is scheduled to expire in one weeks time.

Use to remind a user to renew their consent for continued data access.
PROVIDER_NAME - Name of the Data Holder
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
CONSENT_EXPIRY_TOMORROW User Consent Expires Tomorrow Reminder A reminder that a consent is scheduled to expire the next day.

Use to remind a user to renew their consent for continued data access.
PROVIDER_NAME - Name of the Data Holder
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent
U_CONSENT_PENDING_REMINDER CDR - Pending Consent Reminder A reminder that triggers only once per user. This will remind the user about their pending consent if it is still pending after 1 hour.

Use to prompt a user to complete their consent and provide access to CDR data.
PROVIDER_NAME - Name of the Data Holder
CONSENT_ID - Unique ID of the consent
CONTEXT - Context associated with the Consent