curl -X POST https://api.vouchmark.com/v1/kyb/widgets \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme KYB",
"templateId": "blank",
"environment": "sandbox",
"config": {
"branding": {
"brandName": "Acme",
"logoUrl": "",
"accentColor": "#6466AE",
"cornerRadius": "soft",
"welcomeTitle": "Verify your business",
"welcomeMessage": "This takes about 10 minutes.",
"completionTitle": "All done!",
"completionMessage": "We will review within 24 hours.",
"supportEmail": "support@acme.com"
},
"modules": {
"business_profile": { "enabled": true, "required": true },
"cac_verification": { "enabled": true, "required": true },
"tin_verification": { "enabled": true, "required": true }
},
"flow": {
"order": ["business_profile", "cac_verification", "tin_verification"],
"enableSavedProgress": true,
"enableResume": true,
"sessionTimeoutMinutes": 60,
"successRedirectUrl": "",
"failureRedirectUrl": "",
"abandonRedirectUrl": ""
},
"security": {
"allowedDomains": ["acme.com"],
"allowedCountries": ["NG"],
"enableIpAllowlist": false,
"ipAllowlist": [],
"requireSignedRequests": false
},
"risk": {
"tier": "standard",
"autoApproveThreshold": 80,
"autoRejectThreshold": 30,
"reviewOnPepMatch": true,
"reviewOnAdverseMedia": true,
"reviewOnSanctionsMatch": true
},
"notifications": {
"notifyApplicantEmail": true,
"notifyApplicantSms": false,
"notifyAdminEmail": "compliance@acme.com",
"webhookEvents": ["applicant.approved", "applicant.rejected"]
}
}
}'
{
"success": true,
"data": {
"id": "wgt_aBcD...",
"name": "Acme KYB",
"status": "draft",
"environment": "sandbox",
"templateId": "blank",
"config": { "branding": { "...": "..." }, "modules": { "...": "..." }, "flow": { "...": "..." }, "security": { "...": "..." }, "risk": { "...": "..." }, "notifications": { "...": "..." } },
"embedLinkToken": "elt_...",
"createdAt": "2026-06-01T10:00:00Z",
"updatedAt": "2026-06-01T10:00:00Z"
}
}
Onboarding (KYB)
Create widget
Create a new KYB widget with a full configuration.
POST
/
v1
/
kyb
/
widgets
curl -X POST https://api.vouchmark.com/v1/kyb/widgets \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme KYB",
"templateId": "blank",
"environment": "sandbox",
"config": {
"branding": {
"brandName": "Acme",
"logoUrl": "",
"accentColor": "#6466AE",
"cornerRadius": "soft",
"welcomeTitle": "Verify your business",
"welcomeMessage": "This takes about 10 minutes.",
"completionTitle": "All done!",
"completionMessage": "We will review within 24 hours.",
"supportEmail": "support@acme.com"
},
"modules": {
"business_profile": { "enabled": true, "required": true },
"cac_verification": { "enabled": true, "required": true },
"tin_verification": { "enabled": true, "required": true }
},
"flow": {
"order": ["business_profile", "cac_verification", "tin_verification"],
"enableSavedProgress": true,
"enableResume": true,
"sessionTimeoutMinutes": 60,
"successRedirectUrl": "",
"failureRedirectUrl": "",
"abandonRedirectUrl": ""
},
"security": {
"allowedDomains": ["acme.com"],
"allowedCountries": ["NG"],
"enableIpAllowlist": false,
"ipAllowlist": [],
"requireSignedRequests": false
},
"risk": {
"tier": "standard",
"autoApproveThreshold": 80,
"autoRejectThreshold": 30,
"reviewOnPepMatch": true,
"reviewOnAdverseMedia": true,
"reviewOnSanctionsMatch": true
},
"notifications": {
"notifyApplicantEmail": true,
"notifyApplicantSms": false,
"notifyAdminEmail": "compliance@acme.com",
"webhookEvents": ["applicant.approved", "applicant.rejected"]
}
}
}'
{
"success": true,
"data": {
"id": "wgt_aBcD...",
"name": "Acme KYB",
"status": "draft",
"environment": "sandbox",
"templateId": "blank",
"config": { "branding": { "...": "..." }, "modules": { "...": "..." }, "flow": { "...": "..." }, "security": { "...": "..." }, "risk": { "...": "..." }, "notifications": { "...": "..." } },
"embedLinkToken": "elt_...",
"createdAt": "2026-06-01T10:00:00Z",
"updatedAt": "2026-06-01T10:00:00Z"
}
}
Creates a new onboarding widget. New widgets are created in
Returns
draft status. The full config object is required and must contain every section.
Live widgets require a verified business on the account. Sandbox widgets do not.
Requires Authorization: Bearer $TOKEN.
Body
One of
sandbox or live. Creating a live widget returns 403 until the account has verified a business.config.branding
config.modules
A map keyed by module ID (e.g.
business_profile, cac_verification). Each value has enabled and required booleans, plus an optional placeholders map. See Module catalog for the 19 valid module IDs.Optional input hints keyed by field name, up to 200 characters each and 50 entries per module. Field names must start with a letter, contain only letters and digits, and be at most 80 characters. For example:
"business_profile": { "enabled": true, "required": true, "placeholders": { "legalName": "Your registered company name", "registeredAddress": "Your office address", "contactEmail": "Your work email" } }.These hints apply to text inputs, text areas and editable dropdowns in hosted and embedded widgets. Missing or blank hints use the default text. They do not change field labels, saved answers, validation or read-only fields. You can also edit them under Branding → Input placeholders in the widget editor. When updating a widget, send the complete configuration including any overrides you want to keep.config.flow
config.security
config.risk
config.notifications
curl -X POST https://api.vouchmark.com/v1/kyb/widgets \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme KYB",
"templateId": "blank",
"environment": "sandbox",
"config": {
"branding": {
"brandName": "Acme",
"logoUrl": "",
"accentColor": "#6466AE",
"cornerRadius": "soft",
"welcomeTitle": "Verify your business",
"welcomeMessage": "This takes about 10 minutes.",
"completionTitle": "All done!",
"completionMessage": "We will review within 24 hours.",
"supportEmail": "support@acme.com"
},
"modules": {
"business_profile": { "enabled": true, "required": true },
"cac_verification": { "enabled": true, "required": true },
"tin_verification": { "enabled": true, "required": true }
},
"flow": {
"order": ["business_profile", "cac_verification", "tin_verification"],
"enableSavedProgress": true,
"enableResume": true,
"sessionTimeoutMinutes": 60,
"successRedirectUrl": "",
"failureRedirectUrl": "",
"abandonRedirectUrl": ""
},
"security": {
"allowedDomains": ["acme.com"],
"allowedCountries": ["NG"],
"enableIpAllowlist": false,
"ipAllowlist": [],
"requireSignedRequests": false
},
"risk": {
"tier": "standard",
"autoApproveThreshold": 80,
"autoRejectThreshold": 30,
"reviewOnPepMatch": true,
"reviewOnAdverseMedia": true,
"reviewOnSanctionsMatch": true
},
"notifications": {
"notifyApplicantEmail": true,
"notifyApplicantSms": false,
"notifyAdminEmail": "compliance@acme.com",
"webhookEvents": ["applicant.approved", "applicant.rejected"]
}
}
}'
{
"success": true,
"data": {
"id": "wgt_aBcD...",
"name": "Acme KYB",
"status": "draft",
"environment": "sandbox",
"templateId": "blank",
"config": { "branding": { "...": "..." }, "modules": { "...": "..." }, "flow": { "...": "..." }, "security": { "...": "..." }, "risk": { "...": "..." }, "notifications": { "...": "..." } },
"embedLinkToken": "elt_...",
"createdAt": "2026-06-01T10:00:00Z",
"updatedAt": "2026-06-01T10:00:00Z"
}
}
201 with the full widget object. Set the widget to live with Set widget status when ready.