Overview

Use this method to add a single domain to the list of domains allowed to host the WebSDK for your account, as an API alternative to the Domains to host WebSDK editor in the Dashboard.

See WebSDK settings for background on this allowlist and what it is used for.

Required permissions

To use this method, your app token must have the Manage client's settings permission.

Use case

Use this method to add a new domain to your WebSDK allowlist as part of an automated deployment — for example, when spinning up a new client subdomain — without needing to open the Dashboard.

Request example

curl -X POST
     'https://api.sumsub.com/resources/api/websdkDomains' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>' \
     -H 'Content-Type: application/json' \
     -d '{
           "domain": "app.example.com"
         }'

Response explained

The response is a JSON object with the full, updated list of domains allowed to host the WebSDK.

Response examples

If the request is successfully sent and processed, you will get a response like the one below.

{
  "domains": [
    "example.com",
    "app.example.com"
  ]
}

If the request fails, you will receive an HTTP response containing an error code along with a
message explaining the error. For example, when called by a self-service client:

{
  "description": "This method is not available for self-service clients",
  "code": 403,
  "correlationId": "b628a7fbdf4fa487b26406e79e76f3f7"
}

Response codes