Delete whitelist entries

Removes one or more users from the onboarding whitelist.

Each user must be identified by exactly one of:

national_id: Saudi national ID

external_reference: Your own reference for the user

Send an optional idempotency-key header to make the request safely
retryable — repeating the same key returns the original result.

How to read the response:

200 OK: your request was processed. Check summary.success and
summary.fail to see how many entries were removed. Per-entry conditions
(e.g. entry not on the whitelist) are counted in summary.fail; a 200
does not mean every entry was removed.

4xx / 5xx: your request could not be processed at all. Common reasons
are an invalid request body, missing permissions, or a temporary service
outage. The body contains error_code, error_message, and details.
You can safely retry 5xx responses.

curl --location --request DELETE 'https://api.staging.vrtx.sa/whitelist/' \ --header 'idempotency-key;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "users": [ { "national_id": "1234567890", "external_reference": "ext-ref-001" } ] }'

Delete whitelist entries

Request

Responses