Introduction
This article provides a comprehensive guide on creating OST applicants via the Bud API. It covers the necessary steps to integrate Bud with your CRM system, specify funding streams, and invite applicants to self-register. This guide will be useful to providers wishing leverage Bud’s API capabilities to streamline their end-to-end signup process and includes developer documentation.
Swagger Documentation for Developers
As is typical with APIs, we've created some swagger documentation to support your development and testing when integrating with our APIs.
Rules
There are some rules surrounding this API which must be considered.
- When creating an applicant and assigning the funding model, that funding model MUST be enabled in your tenancy. If you aren't sure about this, contact your Customer Success manager.
- Presently, Applicants for Commercial and Scottish OST Funding Streams are restricted in Bud from self-registration, and thus even if 'inviteOstApplicant is set to true, those applicants still will not be able to self-register.
- When creating Applicants via the API, the self-registration setting in the data model will overrule the providers Feature Switch setting to allow self-registration. So it is important you set that, in-line with your expected behaviours.
Related to