Set onboarding page settings

POST/v1/onboarding_settings

Key scope: write

Sets the origins that may frame the page and its colours. Until at least one origin is set the page cannot be framed (frame-ancestors 'none'); it still opens on its own.

Body

frameAncestors string[]: Up to 10 https origins such as https://app.example.com: no path, no wildcard.
colors { accent?, background?, text? }: 6-digit hex such as 1f6feb, or null for the default. Button text is black or white by contrast.

Errors

400 body_invalid
400 frame_ancestors_invalid
400 colors_invalid
401 api_key_required
401 api_key_invalid
401 api_key_wrong_mode
403 scope_missing
429 rate_limited

All codes: Errors.

Request

curl -X POST "https://wallet.simpleeasytransactions.com/v1/onboarding_settings" \
  -H "Authorization: Bearer $SET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "frameAncestors": ["https://app.example.com"], "colors": { "accent": "1f6feb" } }'

Body

{ "frameAncestors": ["https://app.example.com"], "colors": { "accent": "1f6feb" } }

Response 200

{ "object": "onboarding_settings", "frameAncestors": ["https://app.example.com"], "colors": { "accent": "1f6feb", "background": "ffffff", "text": "111111" }, "sandbox": false }