Set widget status

curl -X PATCH https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD.../status \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"live"}'

{
  "success": true,
  "data": {
    "id": "wgt_aBcD...",
    "name": "Acme KYB",
    "status": "live",
    "environment": "live",
    "templateId": "fintech",
    "config": { "branding": { "...": "..." }, "modules": { "...": "..." }, "flow": { "...": "..." }, "security": { "...": "..." }, "risk": { "...": "..." }, "notifications": { "...": "..." } },
    "embedLinkToken": "elt_...",
    "createdAt": "2026-06-01T10:00:00Z",
    "updatedAt": "2026-06-01T10:05:00Z"
  }
}

PATCH

kyb

widgets

{id}

status

curl -X PATCH https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD.../status \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"live"}'

{
  "success": true,
  "data": {
    "id": "wgt_aBcD...",
    "name": "Acme KYB",
    "status": "live",
    "environment": "live",
    "templateId": "fintech",
    "config": { "branding": { "...": "..." }, "modules": { "...": "..." }, "flow": { "...": "..." }, "security": { "...": "..." }, "risk": { "...": "..." }, "notifications": { "...": "..." } },
    "embedLinkToken": "elt_...",
    "createdAt": "2026-06-01T10:00:00Z",
    "updatedAt": "2026-06-01T10:05:00Z"
  }
}

Transitions a widget between lifecycle states and returns the full updated widget. Requires Authorization: Bearer $TOKEN.

Path parameters

string

required

The widget ID.

Body

string

required

Target status. One of draft, live, or paused.

curl -X PATCH https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD.../status \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"live"}'

{
  "success": true,
  "data": {
    "id": "wgt_aBcD...",
    "name": "Acme KYB",
    "status": "live",
    "environment": "live",
    "templateId": "fintech",
    "config": { "branding": { "...": "..." }, "modules": { "...": "..." }, "flow": { "...": "..." }, "security": { "...": "..." }, "risk": { "...": "..." }, "notifications": { "...": "..." } },
    "embedLinkToken": "elt_...",
    "createdAt": "2026-06-01T10:00:00Z",
    "updatedAt": "2026-06-01T10:05:00Z"
  }
}

Only a live widget can be opened by applicants through its embed link.

Overview

Auth

Companies

Verifications

Onboarding (KYB)

Widget Embed (Runtime)

Trust Badge

Monitoring

Investigations

Disputes

Vouch AI

Compliance

Wallet & Billing

Developers

Path parameters

Body

​Path parameters

​Body

Path parameters

Body