Generate OTP
Header Parameters
The API key assigned by Tuned Global to authenticate and authorize access to this service. Must be included in the request header.
Query Parameters
The user's mobile phone number used for delivering the OTP via SMS. Required if the email parameter is not provided.
A verification hash required by certain OTP providers for SMS validation. Ensures the integrity and authenticity of the SMS request.
Language code for the OTP message content (e.g. en, fr, th)
OTP delivery provider. Default: GBilling. Accepted values: GBilling, Twilio, AwsSns, Email, Infobip, EtLocal, Gabb, Sonsy, GatewayApi
NoneGBillingTwilioFirebaseEmailAwsSnsInfobipEtLocalSonsyThe user's email address used for delivering the OTP via email. Required if the msisdn parameter is not provided.
Response
OK
Response Attributes
Error code returned when the OTP generation request fails. Indicates the type of failure encountered.
Detailed message describing the error encountered during the OTP generation process, providing additional context for troubleshooting.
Bad Request
Unauthorized
Forbidden
Not Found
Response
Status Codes
200
OTP generated and sent successfully.
400
Invalid parameters or configuration.
401
Authentication failure.
403
The API key doesn't have permissions to perform the request.
404
The requested resource does not exist.
Error Codes
600
telco settings not found for group/country.
601
Msisdn or email not found in request.
601
Msisdn must not exceed 15 characters.
601
Failure to properly authenticate yourself in the request.
601
Email not supplied.
601
OTP Provider not supported.
603
Msisdn is not valid.
607
Error generating OTP in db.