2. Verify Mobile OTP
This endpoint verifies the One-Time Password (OTP) sent to the merchant's mobile number during registration. It ensures the provided OTP is valid and matches the session UUID and partner profile number.
Authorization
This endpoint requires the user to have the role
MERCHANT_API_ACCOUNT
Endpoint
POST /api/partner/register/verify-mobile-otp
Request Headers
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token provided by Authentication Endpoint |
Accept | Yes | It must be set to application/JSON. |
Content-Type | Yes | It must be set to application/JSON. |
{
"Authorization": "Bearer [id_token]",
"Accept": "application/json",
"Content-Type": "application/json"
}
Request Body Parameters
The request body must be a JSON object containing the following fields:
Field | Type | Required | Description |
---|---|---|---|
sessionUuid | String | True | The session UUID of the registration |
mobile | String | True | The mobile number of the merchant |
otp | String | True | The OTP received by the merchant |
partnerProfileNo | String | True | The partner profile number |
An example of the request is as follows:
{
"sessionUuid": "12345678-1234-1234-1234-123456789012",
"mobile": "966501234567",
"otp": "123456",
"partnerProfileNo": "12312312"
}
Success Response
The response will be a JSON object of type RegistrationMigrationResponse
.
Field | Type | Description |
---|---|---|
mobile | String | The mobile number of the merchant |
sessionUuid | String | The session UUID |
success | Boolean | Indicates if the OTP verification was successful |
note | String | Any note regarding the response |
Example of the response:
{
"mobile": "00966512345678",
"sessionUuid": "96ea8e22-edef-414b-9724-3bd2d494b710",
"success": true,
"note": "any note ..."
}
HTTP Status Codes
200 OK
: The OTP was successfully verified.400 Bad Request
: The request body is invalid or missing required fields.401 Unauthorized
: The user is not authorized to perform this action.500 Internal Server Error
: An unexpected error occurred on the server.
Updated 6 months ago