Verify onboarding OTP

POST

https://api.staging.vrtx.sa/onboarding/verify-otp

Last modified:2025-12-03 10:51:05

Verifies a user-submitted OTP code for mobile number validation during onboarding.
Validates the OTP against the previously generated code for the specified session.
Returns the session status upon successful verification.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "session_id": "s1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "otp": "1234"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/onboarding/verify-otp' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "session_id": "s1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "otp": "1234"
}'

Responses

🟢200OK

application/json

Default Response

Body

Example

{
    "session_status": "STATUS_UNSPECIFIED"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🟠410Gone

🟠422Unprocessable Entity

🟠429Too Many Requests

🔴500Internal Server Error

🔴501Not Implemented

🔴503Service Unavailable

🔴504Gateway Timeout

🔴505HTTP Version Not Supported

Modified at 2025-12-03 10:51:05

Start onboarding

Resend onboarding OTP