curl --request GET \
--url https://app.vumasign.com/api/v1/brands/{brandId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.vumasign.com/api/v1/brands/{brandId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.vumasign.com/api/v1/brands/{brandId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/brands/{brandId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "9d4f2a6b-1c3e-4d5f-8a7b-6c5d4e3f2a1b",
"name": "NTT DATA",
"email_display_name": null,
"primary_color": "#1d4ed8",
"primary_text_color": "#ffffff",
"logo": {
"url": "https://app.vumasign.com/brand-logos/3f7a1c22-9b41-4f0e-8a1d-2c5e6b7d8f90",
"content_type": "image/png"
},
"is_default": true,
"embed_origins": [
"https://hr.nttdata.example",
"https://staging-hr.nttdata.example"
],
"archived_at": null,
"created_at": "2026-09-01T08:00:00.000Z",
"updated_at": "2026-11-15T09:30:00.000Z"
}{
"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>"
}
}One brand, archived or not.
Its name, colours, logo, whether it is the default, and the origins that may frame its signing pages. An archived brand is returned with its archived_at; a brand of another organisation is not_found, exactly as one that does not exist.
curl --request GET \
--url https://app.vumasign.com/api/v1/brands/{brandId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.vumasign.com/api/v1/brands/{brandId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.vumasign.com/api/v1/brands/{brandId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/brands/{brandId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "9d4f2a6b-1c3e-4d5f-8a7b-6c5d4e3f2a1b",
"name": "NTT DATA",
"email_display_name": null,
"primary_color": "#1d4ed8",
"primary_text_color": "#ffffff",
"logo": {
"url": "https://app.vumasign.com/brand-logos/3f7a1c22-9b41-4f0e-8a1d-2c5e6b7d8f90",
"content_type": "image/png"
},
"is_default": true,
"embed_origins": [
"https://hr.nttdata.example",
"https://staging-hr.nttdata.example"
],
"archived_at": null,
"created_at": "2026-09-01T08:00:00.000Z",
"updated_at": "2026-11-15T09:30:00.000Z"
}{
"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
Response
The brand as it stands now: its colours, its logo, whether it is the default, and its embedding origins.
The brand.