curl -X POST https://api.vouchmark.com/v1/widget/embed/sessions \
-H "Content-Type: application/json" \
-d '{
"token": "elt_..."
}'
{
"success": true,
"data": {
"session": {
"sessionId": "wses_...",
"widgetId": "wgt_aBcD...",
"status": "in_progress",
"currentModuleId": null,
"answers": {},
"attachments": {},
"referenceId": null
},
"widget": {
"widgetId": "wgt_aBcD...",
"name": "Acme KYB",
"status": "live",
"environment": "live",
"config": {
"branding": { "...": "..." },
"flow": { "...": "..." },
"modules": { "...": "..." }
}
}
}
}
Widget Embed (Runtime)
Create embed session
Open a new session for a live widget by its embed token.
POST
/
v1
/
widget
/
embed
/
sessions
curl -X POST https://api.vouchmark.com/v1/widget/embed/sessions \
-H "Content-Type: application/json" \
-d '{
"token": "elt_..."
}'
{
"success": true,
"data": {
"session": {
"sessionId": "wses_...",
"widgetId": "wgt_aBcD...",
"status": "in_progress",
"currentModuleId": null,
"answers": {},
"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.Body
string
required
The widget’s embed link token (
embedLinkToken, starts with elt_).curl -X POST https://api.vouchmark.com/v1/widget/embed/sessions \
-H "Content-Type: application/json" \
-d '{
"token": "elt_..."
}'
{
"success": true,
"data": {
"session": {
"sessionId": "wses_...",
"widgetId": "wgt_aBcD...",
"status": "in_progress",
"currentModuleId": null,
"answers": {},
"attachments": {},
"referenceId": null
},
"widget": {
"widgetId": "wgt_aBcD...",
"name": "Acme KYB",
"status": "live",
"environment": "live",
"config": {
"branding": { "...": "..." },
"flow": { "...": "..." },
"modules": { "...": "..." }
}
}
}
}
201. A session’s status is one of in_progress, submitted, or abandoned. Rate limited to 120 requests per minute.