OTP

Validating user contacts (phone number - email address) using One Time Password.

General Input For Any Request

POST https://api.vlenseg.com/v1/<endpoint_path>

Headers

Name	Type	Description
Content-Type*	string	application/json
ApiKey*	string	API Key
BundleKey*	string	Bundle Key to identify the required services

200: OK success

{
    // Response
}

400: Bad Request Request parameters are not correct

401: Unauthorized Invalid credentials

403: Forbidden You don't have the permission for this service

General Input For Any Validation Request

POST https://api.vlenseg.com/v1/<endpoint_path>

Request Body

Name	Type	Description
validateValue*	string	Value to be validated (phone number or email)
messageSubject*	string	Subject of SMS or email to be sent
expiresInMinutes	int	Minutes to expire the OTP. Default is 5. Max is 10
maxTryCount	string	Max tries count. Default is 5. Max is 10
transactionId	GUID	Transaction ID if needed to link this validation with an existing scan transaction
clientRequestId	string	Any client generated Id that is recognized and used by the client. It will be returned in the response as is.

200: OK success

{
  "data": {
    "requestId": <GUID>,
    "expiresInMinutes": <int>
  },
  "error_code": <int>,
  "error_message": <string>
}

Sending the phone number to be validated by SMS

POST https://<base-url>/​otp​/sms

Verifying the OTP

POST https://<base-url>/​otp​/verify

Request Body

Name	Type	Description
requestId*	GUID	requestId that was returned from the initial request
inputCode*	string	OTP that was sent to user

200: OK success

{
  "data": {
    "isVerified": <bool>,
    "isExpired": <bool>,
    "tryCount": <int>
  },
  "error_code": <int>,
  "error_message": <string>
}