Skip to main content
POST
Create an applicant

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
fullname
string
required

Full name of the applicant

Maximum string length: 75
Example:

"John Smith"

mobileNumber
string
required

Mobile number (numeric only)

Maximum string length: 15
Example:

"1234567890"

email
string<email>
required

Email address of the applicant

Maximum string length: 75
Example:

"john.smith@example.com"

spProductId
string

Service provider product ID

Maximum string length: 4
Example:

"255"

Response

201 - application/json

Applicant created successfully

code
string

Machine-readable result code. See the Error Codes reference.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

message
string

Human-readable result message.

data
object

The response payload.

Last modified on July 14, 2026