Skip to main content
Root whitelist endpoints manage the set of root accounts that are permitted to authorize and onboard when whitelist enforcement is enabled.

​
Check Whitelist Status

Check whether a root account is currently whitelisted. By root address:
Or by public key:
Provide exactly one of root_address or root_public_key. Example response:
The whitelisted field indicates whether the specified root account is currently allowed to authorize. When whitelist enforcement is disabled, all root accounts are treated as whitelisted.

​
Manage Whitelist Entries

Whitelist entries can be managed using the following administrative endpoints. These endpoints are protected using HTTP Basic Authentication and are intended for administrative use only.
Adds or updates a whitelist entry.
Removes a whitelist entry. These endpoints should never be exposed in client applications or SDKs.

​
Root Account Lookup

Authenticated users can retrieve the root account associated with their account.
Example response:
This endpoint is useful when a frontend or SDK needs to display the authenticated user’s root account.