Creating Customer Applications

Assess API (One Time Consent)

The below steps should be followed to integrate with any of Bud's Assess API Solutions with a One Time Consent Model

  • 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 and generate an auth token (v1/oauth/token)
  • Create a new customer application using (/customer-applications). Note the application is only valid for 24 hours and will be automatically deleted after this time has passed.
  • Using the application_id from the above step, retrieve an application URL using (/customer-applications/{{application_id}}/customer-links). When calling this endpoint it is also possible to provide a redirect_url which the customer will be redirected to after they complete the bank account connection journey.
  • Once the customer has successfully connected their bank account you should receive a Connect Completed webhook notification. Following this you can then call your contracted Assess API endpoints.


Clients that are contracted to take Affordability Monitoring or any of our Engage Solutions should create customers using this guide.

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.