Skip to main content
GET
/
v1
/
kyb
/
widgets
/
{id}
curl https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD... \
  -H "Authorization: Bearer $TOKEN"

{
  "success": true,
  "data": {
    "id": "wgt_aBcD...",
    "name": "Acme KYB",
    "status": "live",
    "environment": "live",
    "templateId": "fintech",
    "config": {
      "branding": {
        "brandName": "FinCo",
        "logoUrl": "https://example.com/logo.png",
        "logoPublicId": "kyb-logos/abc123",
        "accentColor": "#6466AE",
        "cornerRadius": "soft",
        "welcomeTitle": "Let's verify your business",
        "welcomeMessage": "This takes about 10 minutes.",
        "completionTitle": "All done!",
        "completionMessage": "We'll review your submission within 24 hours.",
        "supportEmail": "support@finco.com"
      },
      "modules": {
        "business_profile": { "enabled": true, "required": true },
        "cac_verification": { "enabled": true, "required": true },
        "tin_verification": { "enabled": true, "required": true },
        "bank_account_verification": { "enabled": true, "required": true },
        "directors_kyc": { "enabled": true, "required": true },
        "aml_screening": { "enabled": true, "required": false },
        "sanctions_screening": { "enabled": true, "required": true },
        "pep_screening": { "enabled": true, "required": false }
      },
      "flow": {
        "order": ["business_profile", "cac_verification", "tin_verification", "bank_account_verification", "directors_kyc", "aml_screening", "sanctions_screening", "pep_screening"],
        "enableSavedProgress": true,
        "enableResume": true,
        "sessionTimeoutMinutes": 60,
        "successRedirectUrl": "https://finco.com/onboarding/success",
        "failureRedirectUrl": "https://finco.com/onboarding/failed",
        "abandonRedirectUrl": ""
      },
      "security": {
        "allowedDomains": ["finco.com", "app.finco.com"],
        "allowedCountries": ["NG"],
        "enableIpAllowlist": false,
        "ipAllowlist": [],
        "requireSignedRequests": true
      },
      "risk": {
        "tier": "standard",
        "autoApproveThreshold": 80,
        "autoRejectThreshold": 30,
        "reviewOnPepMatch": true,
        "reviewOnAdverseMedia": true,
        "reviewOnSanctionsMatch": true
      },
      "notifications": {
        "notifyApplicantEmail": true,
        "notifyApplicantSms": false,
        "notifyAdminEmail": "compliance@finco.com",
        "webhookEvents": ["applicant.approved", "applicant.rejected", "applicant.requires_review"]
      }
    },
    "embedLinkToken": "elt_...",
    "createdAt": "2026-06-01T10:00:00Z",
    "updatedAt": "2026-06-01T10:00:00Z"
  }
}
Returns the complete widget object including all configuration sections (branding, modules, flow, security, risk, notifications) and the embedLinkToken. Requires Authorization: Bearer $TOKEN.

​
Path parameters

​
id
string
required
The widget ID (starts with wgt_).
curl https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD... \
  -H "Authorization: Bearer $TOKEN"

{
  "success": true,
  "data": {
    "id": "wgt_aBcD...",
    "name": "Acme KYB",
    "status": "live",
    "environment": "live",
    "templateId": "fintech",
    "config": {
      "branding": {
        "brandName": "FinCo",
        "logoUrl": "https://example.com/logo.png",
        "logoPublicId": "kyb-logos/abc123",
        "accentColor": "#6466AE",
        "cornerRadius": "soft",
        "welcomeTitle": "Let's verify your business",
        "welcomeMessage": "This takes about 10 minutes.",
        "completionTitle": "All done!",
        "completionMessage": "We'll review your submission within 24 hours.",
        "supportEmail": "support@finco.com"
      },
      "modules": {
        "business_profile": { "enabled": true, "required": true },
        "cac_verification": { "enabled": true, "required": true },
        "tin_verification": { "enabled": true, "required": true },
        "bank_account_verification": { "enabled": true, "required": true },
        "directors_kyc": { "enabled": true, "required": true },
        "aml_screening": { "enabled": true, "required": false },
        "sanctions_screening": { "enabled": true, "required": true },
        "pep_screening": { "enabled": true, "required": false }
      },
      "flow": {
        "order": ["business_profile", "cac_verification", "tin_verification", "bank_account_verification", "directors_kyc", "aml_screening", "sanctions_screening", "pep_screening"],
        "enableSavedProgress": true,
        "enableResume": true,
        "sessionTimeoutMinutes": 60,
        "successRedirectUrl": "https://finco.com/onboarding/success",
        "failureRedirectUrl": "https://finco.com/onboarding/failed",
        "abandonRedirectUrl": ""
      },
      "security": {
        "allowedDomains": ["finco.com", "app.finco.com"],
        "allowedCountries": ["NG"],
        "enableIpAllowlist": false,
        "ipAllowlist": [],
        "requireSignedRequests": true
      },
      "risk": {
        "tier": "standard",
        "autoApproveThreshold": 80,
        "autoRejectThreshold": 30,
        "reviewOnPepMatch": true,
        "reviewOnAdverseMedia": true,
        "reviewOnSanctionsMatch": true
      },
      "notifications": {
        "notifyApplicantEmail": true,
        "notifyApplicantSms": false,
        "notifyAdminEmail": "compliance@finco.com",
        "webhookEvents": ["applicant.approved", "applicant.rejected", "applicant.requires_review"]
      }
    },
    "embedLinkToken": "elt_...",
    "createdAt": "2026-06-01T10:00:00Z",
    "updatedAt": "2026-06-01T10:00:00Z"
  }
}