Broker API Push Notifications

Update notifications can be obtained through the use of SignalR. This will provide a way to be notified upon two distinct scenarios: Application Update and Electronic Signature Update.

Microsoft Documentation for JavaScript, C# and Java: https://docs.microsoft.com/en-us/azure/azure-signalr/

Overview

  • Negotiate Endpoint
  • This endpoint is protected by the same Authentication as any other Broker endpoint so it will require you to pass in your username and password.
  • Upon successful authentication the API will retrieve your unique Aqua GUID to be used as your SignalR User ID. This is to prevent any other integrators from possibly receiving anothers notifications.

Application Update

  • Trigger Name (on event name)
    • applicationModified
  • Parameters
    • loanApplicationId [long] : the application's ID that was updated
  • Description
    • The provided application id which has an update. Updates include applicant information, stipulations, loan details, etc.

Electronic Signature Update

  • Trigger Name (on event name)
    • signatureModified
  • Parameters
    • loanApplicationId [long] : the application's ID that was updated
  • Description
    • The provided application id which has a signature update.
  • Improve this Doc
Back to top Copyright © 2015–2018 Aqua Finance
Generated by DocFX