Skip to main content
POST
Register one origin that may frame this brand’s signing pages.

Authorizations

Authorization
string
header
required

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

brandId
string<uuid>
required

The brand’s id, from GET /api/v1/brands or Settings → Brands. A brand id.

Example:

"5d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d"

Body

application/json

The origin to add. At most 4096 bytes; a larger body is refused with invalid_request.

The origin.

origin
string
required

A bare origin: https://, a host and an optional port. No trailing slash, no path, no wildcard, lowercase. Anything else is refused with the reason, not repaired.

Example:

"https://app.customer.example"

Response

The brand’s embedding origins after the change.

The origins.

embed_origins
string[]
required

Every origin now registered against the brand, sorted.

A bare origin.