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"
}
}
Onboarding (KYB)
Set widget status
Change a widget’s status — draft, live, or paused.
PATCH
/
v1
/
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
Only a
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"
}
}
live widget can be opened by applicants through its embed link.