Skip to main content
POST
Verify a custom domain and advance provisioning

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Opaque brand id (brd_...). Validated to belong to the resolved client (§2).

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Path Parameters

brand_id
string
required

the brand whose custom domains to view or manage (must match X-Brand-Id).

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$
kind
enum<string>
required

the custom-domain kind — login (the auth domain) or member (the member-portal domain).

Available options:
login,
member

Response

the advanced row (login → active; member → cert_requested)

data
object
required

One custom-domain row as the registry holds it: the brand, the kind (login | member), the hostname, its provisioning state, who owns and who bound the host, timestamps, and the CNAME paste-row to add to your DNS. The row never carries a secret nor the provider's internal domain id. An absent row (a kind you have not registered) is the shared-domain default.