Start onboarding

POST

https://api.staging.vrtx.sa/onboarding/start

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

Validates a user's mobile number and National ID, verifies ownership, and sends an OTP to start the onboarding session.
A 200 OK is returned only if all validations pass and the OTP is dispatched successfully.
Otherwise, a structured error response is returned.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "mobile_number": "966501234567",
    "national_id": "1234567890",
    "locale": "ar",
    "external_reference": "partner-ref-abc123"
}

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/start' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mobile_number": "966501234567",
    "national_id": "1234567890",
    "locale": "ar",
    "external_reference": "partner-ref-abc123"
}'

Responses

🟢200OK

application/json

Default Response

Body

Example

{
    "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82"
}

🟠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

Verify onboarding OTP