Start onboarding

POST

/onboarding/start

Last modified:2025-12-02 10:06:51

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

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Default Response

Body

🟠400400

🟠401401

🟠403403

🟠404404

🟠405405

🟠409409

🟠410410

🟠422422

🟠429429

🔴500500

🔴501501

🔴503503

🔴504504

🔴505505

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/onboarding/start' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mobile_number": "966501234567",
    "national_id": "1234567890",
    "locale": "ar",
    "external_reference": "partner-ref-abc123"
}'

Response Example

200 - Example 1

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

Modified at 2025-12-02 10:06:51

Token

Verify onboarding OTP