Skip to content

Get the capture-page branding for a programme

GET/v1/kyc/branding

Requires an API client bearer token.

Returns the per-programme capture-page branding (display name, accent colours, default theme, logo metadata) for the hosted capture widget. An absent row is not an error — it is the default unbranded posture (`branding: null`). Metadata only; logo bytes are never inlined here. Accepts an optional `flow_key` selector (default `'default'`); an unknown key 400s `unknown_flow`, while an archived flow still reads back. The resolved key is echoed back as `flow_key`. Requires membership of the programme: the selector's 400-vs-200 split is programme knowledge, not a tenant-wide read, so a caller pinned to another programme in the tenant 403s.

Parameters

Query parameters

NameRequiredDescription
programme_idrequired
flow_keyoptional

Example

curl https://api.rigid.fi/v1/kyc/branding \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The capture-page branding for the programme, or `null` if none is set.

programme_idstringrequired
flow_keystringrequired
brandingobject | nullrequired
+ show properties
display_namestring
accent_lightstring
accent_darkstring
default_theme"light" | "dark"
logoobject
+ show properties
content_typestringrequired
versionintegerrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring