curl --request POST \
--url https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"origin": "https://staging-hr.nttdata.example"
}
'import requests
url = "https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins"
payload = { "origin": "https://staging-hr.nttdata.example" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({origin: 'https://staging-hr.nttdata.example'})
};
fetch('https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins"
payload := strings.NewReader("{\n \"origin\": \"https://staging-hr.nttdata.example\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"embed_origins": [
"https://hr.nttdata.example",
"https://staging-hr.nttdata.example"
]
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Register one origin that may frame this brand’s signing pages.
⚠️ THIS WIDENS WHICH SITES CAN FRAME SIGNING PAGES: the origin may frame the embedded signing page of every envelope sent under this brand, so brands:write is explicit-only — a full-access key does not hold it unless it was minted naming it — and live-only: a vsk_test_ key is refused test_key_cannot_edit_brands, because a brand serves live sends too.
IDEMPOTENT: an origin already registered is the same 200 as one just added, and changes nothing; an explicit :443 is the same origin as one without it. A brand holds at most 20. An origin applies to signing URLs minted after it is added; one minted before carries the old list.
One origin per call, rather than the whole list. A save in Settings → Brands applies only what the person changed in the list they loaded, so an origin added here while that screen was open is kept. An archived brand is refused brand_is_archived.
curl --request POST \
--url https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"origin": "https://staging-hr.nttdata.example"
}
'import requests
url = "https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins"
payload = { "origin": "https://staging-hr.nttdata.example" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({origin: 'https://staging-hr.nttdata.example'})
};
fetch('https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/brands/{brandId}/embed-origins"
payload := strings.NewReader("{\n \"origin\": \"https://staging-hr.nttdata.example\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"embed_origins": [
"https://hr.nttdata.example",
"https://staging-hr.nttdata.example"
]
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Authorizations
Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.
Path Parameters
Body
The origin to add. At most 4096 bytes; a larger body is refused with invalid_request.