curl "https://api.vouchmark.com/v1/widget/embed/sessions/wses_...?token=elt_..."
{
"success": true,
"data": {
"session": {
"sessionId": "wses_...",
"widgetId": "wgt_aBcD...",
"status": "in_progress",
"currentModuleId": "cac_verification",
"answers": {
"business_profile": { "legalName": "Acme Trading Ltd", "registrationNumber": "RC123456" }
},
"attachments": {},
"referenceId": null
},
"widget": {
"widgetId": "wgt_aBcD...",
"name": "Acme KYB",
"status": "live",
"environment": "live",
"config": {
"branding": { "...": "..." },
"flow": { "...": "..." },
"modules": { "...": "..." }
}
}
}
}
Widget Embed (Runtime)
Resume embed session
Resume an existing widget session by its ID and embed token.
GET
/
v1
/
widget
/
embed
/
sessions
/
{sessionId}
curl "https://api.vouchmark.com/v1/widget/embed/sessions/wses_...?token=elt_..."
{
"success": true,
"data": {
"session": {
"sessionId": "wses_...",
"widgetId": "wgt_aBcD...",
"status": "in_progress",
"currentModuleId": "cac_verification",
"answers": {
"business_profile": { "legalName": "Acme Trading Ltd", "registrationNumber": "RC123456" }
},
"attachments": {},
"referenceId": null
},
"widget": {
"widgetId": "wgt_aBcD...",
"name": "Acme KYB",
"status": "live",
"environment": "live",
"config": {
"branding": { "...": "..." },
"flow": { "...": "..." },
"modules": { "...": "..." }
}
}
}
}
This is an embed runtime endpoint. It is called by the embedded Vouchmark widget in the applicant’s browser, not by your backend. It uses the widget’s
token and does not take a Bearer token.Path parameters
Query parameters
curl "https://api.vouchmark.com/v1/widget/embed/sessions/wses_...?token=elt_..."
{
"success": true,
"data": {
"session": {
"sessionId": "wses_...",
"widgetId": "wgt_aBcD...",
"status": "in_progress",
"currentModuleId": "cac_verification",
"answers": {
"business_profile": { "legalName": "Acme Trading Ltd", "registrationNumber": "RC123456" }
},
"attachments": {},
"referenceId": null
},
"widget": {
"widgetId": "wgt_aBcD...",
"name": "Acme KYB",
"status": "live",
"environment": "live",
"config": {
"branding": { "...": "..." },
"flow": { "...": "..." },
"modules": { "...": "..." }
}
}
}
}
