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. Management
  • Issuance
    • Issue card
      POST
    • Get card issuance
      GET
    • Complete card issuance
      POST
    • Verify card issuance OTP
      POST
    • Convert virtual to physical
      POST
    • Verify card conversion OTP
      POST
  • Management
    • Get card
      GET
    • Change card status
      PATCH
    • Set or update card PIN
      POST
    • Verify card PIN OTP
      POST
    • Activate physical card
      POST
    • Verify activation OTP
      POST
    • Display sensitive data
      POST
    • Verify display sensitive data OTP
      POST
  1. Management

Verify activation OTP

POST
https://api.staging.vrtx.sa/cards/activate/verify-otp
Last modified:2025-12-03 10:51:05
Confirms a physical card activation by verifying the OTP sent during the initiate step.
Provide the session_id returned earlier along with the OTP to complete activation.
Request:
session_id: Activation session identifier
otp: 4 digit OTP sent to the user
idempotency-key: Unique key to ensure idempotent requests
Response:
card_status: Resulting status of the card after activation is confirmed
Error Responses:
404 CARD_NOT_FOUND/CARD_ISSUANCE_NOT_FOUND: Card or activation session missing
412 CARD_EXPIRED/ACTIVATION_NOT_ALLOWED: Card expired or not allowed to activate
400 ACTIVATION_FAILED: OTP validation failed or activation could not finish
503 SERVICE_UNAVAILABLE: Backend temporarily unavailable

Request

Header Params

Body Params application/jsonRequired

Example
{
    "session_id": "f1e2d3c4-b5a6-7890-c1d2-e3f4a5b6c7d8",
    "otp": "5678"
}

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/cards/activate/verify-otp' \
--header 'idempotency-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "session_id": "f1e2d3c4-b5a6-7890-c1d2-e3f4a5b6c7d8",
    "otp": "5678"
}'

Responses

🟢200OK
application/json
Default Response
Body

Example
{
    "card_status": "ACTIVE"
}
đźź 400Bad Request
đźź 401Unauthorized
đźź 403Forbidden
đźź 404Not Found
đźź 405Method Not Allowed
đźź 409Conflict
đźź 410Gone
đźź 412Precondition Failed
đźź 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
Activate physical card
Next
Display sensitive data
Built with