Skip to main content
POST
Register a domain

Authorizations

Authorization
string
header
required

JWT bearer token obtained via the OAuth2 client-credentials grant from the platform Authentication API. The token's scopes gate the endpoints it may call, and its audience names the Guardian instance. This is the standard way to authenticate to Guardian.

Body

application/json
domain
string
required

Fully-qualified domain name.

Example:

"pay.example.com"

Response

Success response

id
string<uuid>
required
Example:

"3d7f1b5a-9c4e-4f2d-b8a6-1e5c9d3b7f4a"

domain
string
required
Example:

"pay.example.com"

state
enum<string>
required
Available options:
pending,
verified,
failed
Example:

"verified"

created_at
string<date-time>
required
Example:

"2026-02-01T09:15:00Z"

last_verified_at
string<date-time> | null
Example:

"2026-02-05T11:00:00Z"