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. Start
  • Welcome 👋
  • Get Started
  • Auth
    • Token
      POST
  • Onboarding
    • Start onboarding
      POST
    • Verify onboarding OTP
      POST
    • Resend onboarding OTP
      POST
    • Get session status
      GET
    • Initiate Nafath
      POST
    • Cancels session
      POST
    • Complete customer info
      POST
  • Wallet
    • Change mobile number from profile settings
      • Change mobile number
      • Verify mobile number change OTP
      • Get mobile change status
    • Change mobile number from login screen
      • Change mobile number
      • Verify mobile number change OTP
      • Initiate Nafath
      • Get mobile number change status
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Cards
    • Issuance
      • Issue card
      • Get card issuance
      • Complete card issuance
      • Verify card issuance OTP
      • Convert virtual to physical
      • Verify card conversion OTP
    • Management
      • Get card
      • Change card status
      • Set or update card PIN
      • Verify card PIN OTP
      • Activate physical card
      • Verify activation OTP
      • Display sensitive data
      • Verify display sensitive data OTP
  • Transactions
    • Business Accounts
      • Get business account balance
      • Get transaction details
      • List business transactions
    • Wallet Accounts
      • Get wallet balance
      • List wallet transactions
  • cards
    • Initiate card replacement
      POST
    • Verify OTP and complete card replacement
      POST
  1. Start

Get Started

The vrtx Core APIs provide a modern, secure, and compliant foundation for embedding end-to-end financial capabilities directly into your platform. Using these RESTful APIs, developers can onboard users, issue cards, manage wallets, disburse funds, and retrieve transactions — all without building or maintaining regulated financial and compliance infrastructure.
image.png
vrtx Regulated Financial Infrastructure
📌
vrtx enables you to launch regulated and compliant financial products in weeks — including user onboarding, wallets, card programs, payouts, and real-time transaction processing.

APIs Overview#

vrtx exposes a modular suite of APIs that allow you to compose and scale your financial program with flexibility and control:
Onboarding
Start Onboarding
Initiate onboarding session for a user (identity/document collection), first step in user KYC flow.
Verify Onboarding OTP
Verify OTP to continue onboarding process (as part of identity verification flow).
Resend Onboarding OTP
Resend OTP if user did not receive the code during onboarding.
Get Onboarding Session Status
Retrieve status of a user’s onboarding session (pending, verified, etc.).
Initiate Nafath
Initiate national-ID (Nafath) authentication for identity verification.
Cancel Onboarding Session
Cancel an ongoing onboarding flow (if user abandons or fails verification).
Complete Customer Info
Submit full customer info (after verification steps) to finalize onboarding.
Wallet Management
Payouts
Cards
Transactions

Requirements#

These are the minimum requirements to onboard users and operate financial services with vrtx Core APIs:
1
Get Access
Ability to make authenticated API requests using vrtx-issued program keys.
2
Complete Onboarding Flows
Understanding of KYC/KYB, identity verification, risk scoring, and user activation.
3
Configure Your Program
Define your wallet tiers, card program settings, payout rules, and limits.
4
Launch!
Move from sandbox to production and start issuing cards, wallets, and payouts.

Authentication#

vrtx Core APIs use API-key authentication, generated for each business program.
Keys provide scoped access to:
Onboarding flows
Wallet operations
Card issuance and lifecycle events
Payouts
Transaction retrieval

Rate Limits#

vrtx enforces rate limits to ensure fairness and platform stability.
Exceeding your allocated throughput returns:
429 Too Many Requests
Contact your account manager to request higher limits for production workloads.

Language Support#

All vrtx Core APIs return responses in English.
Multilingual data fields (e.g., names, labels) may support Arabic and English where applicable.

Try It Out#

For quick integration:
Use Postman, Apidog, Insomnia, or any REST client.
Import the vrtx sandbox collection (coming soon).
Start with the Onboarding and Wallet modules.

Changelog#

Follow updates for:
New endpoints
Security enhancements
Card program expansions
Breaking changes
Deprecations
Modified at 2025-11-27 09:56:59
Previous
Welcome 👋
Next
Token
Built with