Assess API to Assess Dashboard Create Customer Application Journey

The below steps should be followed when integrating the hybrid Assess API to Assess Dashboard Journey.

The hybrid Assess API to Assess Dashboard journey enables you to create customer applications via the Bud API and integrate with Assess API endpoints, but also enables your agents/underwriters to be able to review these applications within the Bud Assess Dashboard.

📘

Please note Bud will need to set up and configure the Assess Dashboard website and connect this to your Bud developer console account.

  • Sign up to the Bud developer console and generate a new Project/API key to access our sandbox environment. This is where we will also enable your production environment access.
  • Setup the Connect Completed webhook within our developer console to be notified as soon as customers have completed connecting their bank account.

The next steps below should be integrated into your application in line with our best practice recommendations guide. If you have any questions throughout your integration, simply click the “Ask AI” button which can be found on all our docs and guides. Or alternatively submit a technical support request to our Technical Delivery team.

  • Authenticate with the Bud API (v1/oauth/token)
  • Create a new customer application using (/customer-applications).
  • Using the application_id from the above step, retrieve an application URL using (/customer-applications/{{application_id}}/customer-links). The link can be emailed directly to the customer or you can redirect the customer to the generated link provided in the API response. Note the application URL is only valid for 24 hours by default. Link expiry can be extended beyond 24 hours up to a maximum of 5 days.
  • Once the customer has successfully connected their bank account you should receive a Connect Completed webhook notification. Following this you can then review the application in the Assess Dashboard and call your contracted Assess API endpoints.

What’s Next

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.