1. Onboarding
Vrtx Docs
  • 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
  • Webhooks
    • Process Nafath webhook
      POST
    • Process Faceki webhook
      POST
    • Process T2 webhook
      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
  • Businesses
    • Create business
      POST
  • Transactions
    • Business Accounts
      • Get business account balance
      • Get transaction details
      • List business transactions
    • Wallet Accounts
      • Get wallet balance
      • List wallet transactions
  • 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
  • cards
    • Initiate card replacement
    • Verify OTP and complete card replacement
Open-Loop-v2Closed-loop V2Card Simulatoropen-loop-test
Open-Loop-v2Closed-loop V2Card Simulatoropen-loop-test
  1. Onboarding

Verify onboarding OTP

POST
/onboarding/verify-otp
Last modified:2025-12-02 10:06:51
Verifies a user-submitted OTP code for mobile number validation during onboarding.
Validates the OTP against the previously generated code for the specified session.
Returns the session status upon successful verification.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Default Response
Body

đźź 400400
đźź 401401
đźź 403403
đźź 404404
đźź 405405
đźź 409409
đźź 410410
đźź 422422
đźź 429429
đź”´500500
đź”´501501
đź”´503503
đź”´504504
đź”´505505
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/onboarding/verify-otp' \
--header 'Content-Type: application/json' \
--data-raw '{
    "session_id": "s1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "otp": "1234"
}'
Response Response Example
200 - Example 1
{
    "session_status": "STATUS_UNSPECIFIED"
}
Modified at 2025-12-02 10:06:51
Previous
Start onboarding
Next
Resend onboarding OTP
Built with