vrtx Docs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
  1. Change mobile number from login screen
  • Change mobile number from profile settings
    • Change mobile number
      POST
    • Verify mobile number change OTP
      POST
    • Get mobile change status
      GET
  • Change mobile number from login screen
    • Change mobile number
      POST
    • Verify mobile number change OTP
      POST
    • Initiate Nafath
      POST
    • Get mobile number change status
      GET
  1. Change mobile number from login screen

Initiate Nafath

POST
https://api.staging.vrtx.sa/login/change-mobile-number/nafath/initiate
Last modified:2025-12-03 10:51:05
Initiates Nafath biometric authentication for mobile number change verification.
This API is used for logged-out users who need additional identity verification.
Returns a challenge code when the Nafath session is successfully initiated.

Request

Body Params application/jsonRequired

Example
{
    "session_id": "s1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "nafath_request_id": "NFR-1234567890"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.staging.vrtx.sa/login/change-mobile-number/nafath/initiate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "session_id": "s1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "nafath_request_id": "NFR-1234567890"
}'

Responses

🟢200OK
application/json
Default Response
Body

Example
{
    "status": "PENDING_MOBILE_NUMBER_OWNERSHIP_VERIFICATION",
    "nafath_status": "PENDING_NAFATH_VERIFICATION",
    "random_challenge_code": "string"
}
đźź 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
Previous
Verify mobile number change OTP
Next
Get mobile number change status
Built with