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. 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
  1. Onboarding

Get session status

GET
https://api.staging.vrtx.sa/onboarding/get-session-status/{session_id}
Last modified:2025-12-03 10:51:05
Returns only the status information of a session without the detailed execution data.
This lightweight endpoint is useful for polling the current state of a session.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

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 GET 'https://api.staging.vrtx.sa/onboarding/get-session-status/' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
Default Response
Body

Example
{
    "status": "STATUS_UNSPECIFIED",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"
}
đźź 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
Resend onboarding OTP
Next
Initiate Nafath
Built with