API Reference

Authenticates a user using a one-time pin

post
{protocol}://{domain}/helpdesk/auth/onetime

Authenticates a user using a one-time pin sent via SMS or email. The user must provide their reference number, date of birth, and one-time pin to be authenticated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

User reference, date of birth, and one-time pin for authentication

string
required

Reference number of the user. Must be numeric with a maximum length of 12.

date
required

User's date of birth in YYYY-MM-DD format

string
required

Four-digit one-time pin provided to the user. Must be exactly 4 digits.

string
required

The token generated by the client-side reCAPTCHA widget. This token is used for server-side validation to confirm that the user's interactions are genuine.

string
required

The version of the reCAPTCHA widget being used. Knowing the version is essential for proper server-side validation.

Responses

Updated over 2 years ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago