Change mobile number

POST

https://api.staging.vrtx.sa/profile/change-mobile-number

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

Allows an existing user who is LOGGED IN to change the mobile number linked to their wallet account.

This endpoint initiates the mobile number change process by:

Validating the customer exists using the provided customer ID

Verifying ownership of the new mobile number through Yakeen

Sending an OTP to the new mobile number

Starting a session that will require:

OTP verification

The process ensures secure transfer of the account to a new mobile number in compliance with SAMA requirements.

Rate Limiting: Users can only change their mobile number once per 24-hour period.

Important: This API handles the initial request. Additional endpoints will be needed for:

OTP verification

Status checking

Request

Body Params application/jsonRequired

Example

{
    "customer_id": "c1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "new_mobile_number": "966501234567",
    "locale": "ar"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/profile/change-mobile-number' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "c1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "new_mobile_number": "966501234567",
    "locale": "ar"
}'

Responses

🟢200OK

application/json

Default Response

Body

Example

{
    "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "status": "PENDING_MOBILE_NUMBER_OWNERSHIP_VERIFICATION"
}

🟠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 mobile number change OTP