Create and manage Applicants via the API

Introduction

This is likely to be useful for Customers who would like to integrate Bud with their CRM Systems, to help streamline their end-to-end signup processes. 

Bud provides the ability to

 

Create an Applicant

We provide the ability to create a new applicant and assign all the necessary information for the individual to be invited and self-serve their information.

 

Collection Field Name Required? Data Type Validation
Personal Details Title No String Must be one of the valid Bud titles
First Name Yes String  
Middle Names No String  
Last Name Yes String  
Email Yes String Must match email regex
Mobile No String Must match phone number regex
Gender Yes String 0 Female, 1 Male
Date of Birth Yes DateTime  
Ethnicity No Int  
Address Line 1 Yes String  
Line 2 No String  
Line 3 No String  
Line 4 No String  
Line 5 No String  
Town No String  
Country No String  
Postcode Yes String Must match postcode regex
n/a Employer Contact ID Yes GUID  
n/a Sector ID Yes GUID  
n/a Programme ID Yes GUID  
n/a Lead Generator ID No GUID  
n/a Invite Applicant Yes Boolean  
n/a Should ask Applicant for ID Document   Boolean  
n/a Is Learning Style Assessment Enabled   Boolean  

Endpoint POST   /Application/V2

 

In addition, we provide a secondary endpoint to create a cut down version of the Applicant record. This is useful if you’ve been provided a sub-set of information about an Applicant.

 

Collection Field Name Required? Data Type Validation
Personal Details Fore Name Yes String Must be one of the valid Bud titles
Middle names No String  
Surname Yes String  
Email Yes String Must match email regex
Mobile No String Must match phone number regex
n/a Employer Contact ID Yes GUID  
n/a Indicated Sector ID Yes GUID  
n/a Invite Applicant Yes Boolean  
n/a Lead Generator ID Yes GUID  

Endpoint POST    /Application

 

Retrieve information about the Applicant

With the GUID of an Applicant, it is possible to return some information about the Applicant, such as their personal information, Programme, Sector, and the status of the Applicant. 

 

Collection Field Name Nullable Data Type
Personal Details Title Yes  
First Name No String
Middle names Yes String
Last name No String
Email No String
Mobile Yes String
Gender No String
Date of Birth No String
Ethnicity ID Yes Int
Ethnicity Name Yes String
Application Status Title No String
Address Line 1 No String
Line 2 Yes String
Line 3 Yes String
Town Yes String
Postcode No String
Employer Contact ID No GUID
Name No String
n/a Sector ID No GUID
Programme ID No GUID
Name No String
Lead generator ID Yes GUID
First Name Yes String
Last name Yes String

Endpoint GET   /Application

 

Add evidence to an Applicant

It is possible to add Files to an Applicant as supporting or qualification evidence. There are two endpoints for each. Files, that amount to no more than 500mbs can be included in the method.

 

Collection Field Name Required? Data Type Validation
n/a values Yes String JSON list of qualifications
n/a file Yes File Cannot be greater than 500mb

Endpoint POST   /application/{applicationId}/qualification-evidence

 

 

Collection Field Name Required? Data Type Validation
  file Yes File Cannot be greater than 500mb

Endpoint POST   /application/{applicationId}/supporting-evidence

 

 

Related to

Was this article helpful?

1 out of 1 found this helpful

Have more questions? Submit a request