Get whitelist entries

GET

https://api.sandbox.vrtx.sa/whitelist/

Last modified:2026-05-18 06:45:20

Returns a paginated list of users on the onboarding whitelist.

Query parameters:

added_on (optional): Filter to entries added on this date (YYYY-MM-DD).

page (optional): Page number, starting at 1. Default: 1.

limit (optional): Entries per page, 1–100. Default: 50.

Each entry returns its identifier (national_id or external_reference)
and the created_at timestamp in ISO 8601 format.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Default Response

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠405

🟠409

🟠410

🟠422

🟠429

🔴500

🔴501

🔴503

🔴504

🔴505

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.sandbox.vrtx.sa/whitelist/?added_on=undefined&page=undefined&limit=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "white_listed_users": [
        {
            "national_id": "string",
            "external_reference": "string",
            "created_at": "string"
        }
    ],
    "total_count": 0,
    "total_pages": 0,
    "current_page": 0
}

Modified at 2026-05-18 06:45:20

Add whitelist entries

Delete whitelist entries