Set or clear the capture-page branding for a programme
/v1/kyc/brandingRequires an API client bearer token.
Sets, updates, or clears a programme’s capture-page branding (display name, accent colours, default theme, logo). A field OMITTED from the body keeps its stored value; a field explicitly `null` clears it. Requires Idempotency-Key; an identical retry returns the SAME stored branding. Accepts an optional `flow_key` selector (default `'default'`); an unknown key 400s `unknown_flow` and an archived one 400s `flow_archived`. The resolved key is echoed back as `flow_key`.
Parameters
Header parameters
| Name | Required | Description |
|---|---|---|
| Idempotency-Key | required | Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409. |
Request body
+ show properties− hide properties
Example
curl -X POST https://api.rigid.fi/v1/kyc/branding \
-H "Authorization: Bearer $RIGID_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"programme_id": "uuid"
}'Responses
200The stored capture-page branding for the programme.
+ show properties− hide properties
+ show properties− hide properties
400Validation error
401Authentication required
403Forbidden
409Idempotency-Key reused with a different payload
429Too many KYC writes from this caller — see Retry-After
500Internal server error