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. Nafath
  • Card Transactions
    • Perform a simulated card transaction
      POST
    • Perform a balance inquiry
      POST
  • Notifications
    • Fetch the latest OTP for a mobile number
      POST
  • Nafath
    • Trigger Nafath completion webhook
      POST
    • Preview Nafath completion webhook payload
      POST
  1. Nafath

Preview Nafath completion webhook payload

POST
https://api.staging.vrtx.sa/testhelpers/nafath/complete/dry-run
Last modified:2025-12-10 09:01:59
Builds the webhook payload (token + body) without sending it, so you can inspect the claims after applying overrides like expiry, address removal, or randomized names.

Request

Body Params application/jsonRequired

Example
{
    "requestId": "string",
    "database": "ONBOARDING",
    "idExpiryDateG": "string",
    "idExpiryDateH": "string",
    "iqamaExpiryDateG": "string",
    "iqamaExpiryDateH": "string",
    "missingNationalAddress": true,
    "randomizeName": true,
    "firstName": "string",
    "secondName": "string",
    "thirdName": "string",
    "lastName": "string"
}

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/testhelpers/nafath/complete/dry-run' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "string",
    "database": "ONBOARDING",
    "idExpiryDateG": "string",
    "idExpiryDateH": "string",
    "iqamaExpiryDateG": "string",
    "iqamaExpiryDateH": "string",
    "missingNationalAddress": true,
    "randomizeName": true,
    "firstName": "string",
    "secondName": "string",
    "thirdName": "string",
    "lastName": "string"
}'

Responses

🟢200OK
application/json
Preview generated
Body

Example
{
    "requestId": "string",
    "transId": "string",
    "token": "string",
    "payload": {
        "property1": "string",
        "property2": "string"
    }
}
🟠404Not Found
Modified at 2025-12-10 09:01:59
Previous
Trigger Nafath completion webhook
Built with