Authenticate
Invoke the cobrand login service to perform cobrand authentication and retrieve a cobrand session token.
NOTE: If you already have an active cobrand token, you can use it.
Subscribe
Subscribe to the DATA_UPDATES event using the subscribe event service. Provide the callback URL where you need to post notifications.
NOTE: This is a one-time activity unless and until there is a change to the URL.
Listen
Yodlee will post the data update notifications to the callback URL provided during DATA_UPDATES event subscription. The default notification interval is 15 minutes. For more information about the event payload, refer to Event Payload Information.
Retrieve
After receiving notifications, invoke the get user data service to retrieve the updated information. The input needed to invoke the get user data service will be available in the payload provided during the notification.
Fallback Option
If you experience technical issues or if your server is down you can miss notifications from Yodlee. If the notification is not successfully delivered, Yodlee will retry three time with a 10 minutes interval. During such events, Yodlee recommends that you use the DATA_UPDATES Event Polling approach for that time period.
If Yodlee servers are down due to any unavoidable circumstances, Yodlee will send notifications to customers with the complete data updates that happened during the server downtime.
DATA_UPDATES Event Notification API Flow
NOTE:
- The data updates event notification will be sent every 15 minutes with the details of the user whose data has been updated.
- The data updates event will be sent only if there are updates to the data.
- Once the notification is received, customers are expected to invoke Get User Data service using the information provided in the notification.
- The content-type of the notification will be application/x-www-form-urlencoded