Overview

Sections

Theme switcher

Validate OTP

Header Parameters

Authorizationstring Required

Bearer token

StoreIdstring Required

StoreId API key provided by Tuned Global to authenticate and authorize access to the service

Query Parameters

msisdnstring Required

The mobile phone number to which the OTP was sent. Required if email is not provided.

otpstring Required

The one-time password entered by the user for verification.

emailstring Required

The email address to which the OTP was sent. Required if msisdn is not provided.

Response

200
Object

OK

Response Attributes

errorstring

Indicates the type of error encountered during the OTP validation process, if any.

error_descriptionstring

A detailed message explaining the reason for the error, if the OTP validation fails.

400
Object

Bad Request

401
Object
403
Object

Forbidden

404
Object

Not Found

409
Object
500
Object

Server Error

Was this section helpful?

GET

/

Select
1

Response

Status Codes

200

OK

Success - OTP validated successfully.

400

Bad request

The request was unacceptable, often due to missing a required parameter.

401

Unauthorized

The request was unacceptable, often due to missing a required parameter.

402

Request Failed

The parameters were valid but the request failed.

403

Forbidden

The API key doesnt have permissions to perform the request.

404

Not Found

The requested resource does not exist.

409

Conflict

OTP is validated successfully and user already exists.

Error Codes

400

otp validation failed

401

maximum attempts reached.

601

msisdn, email or otp not supplied.

603

msisdn not valid.

610

otp validation successful and user already exists

Was this section helpful?