curl https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD.../estimate \
-H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"widgetId": "wgt_aBcD...",
"currency": "NGN",
"sessionBaseKobo": 50000,
"perVerificationKobo": 1250000,
"totalPerVerificationKobo": 1300000,
"enabledCount": 8,
"breakdown": [
{ "moduleId": "business_profile", "name": "Business profile", "category": "business", "actionKey": "kyb_business_profile", "priceKobo": 0, "enabled": true, "required": true },
{ "moduleId": "cac_verification", "name": "CAC verification", "category": "identity", "actionKey": "kyb_cac_verification", "priceKobo": 150000, "enabled": true, "required": true },
{ "moduleId": "tin_verification", "name": "TIN verification", "category": "identity", "actionKey": "kyb_tin_verification", "priceKobo": 100000, "enabled": true, "required": true },
{ "moduleId": "scuml", "name": "SCUML registration", "category": "identity", "actionKey": "kyb_scuml", "priceKobo": 0, "enabled": false, "required": false }
]
}
}
Onboarding (KYB)
Widget cost estimate
Get the per-applicant cost estimate for a widget’s current configuration.
GET
/
v1
/
kyb
/
widgets
/
{id}
/
estimate
curl https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD.../estimate \
-H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"widgetId": "wgt_aBcD...",
"currency": "NGN",
"sessionBaseKobo": 50000,
"perVerificationKobo": 1250000,
"totalPerVerificationKobo": 1300000,
"enabledCount": 8,
"breakdown": [
{ "moduleId": "business_profile", "name": "Business profile", "category": "business", "actionKey": "kyb_business_profile", "priceKobo": 0, "enabled": true, "required": true },
{ "moduleId": "cac_verification", "name": "CAC verification", "category": "identity", "actionKey": "kyb_cac_verification", "priceKobo": 150000, "enabled": true, "required": true },
{ "moduleId": "tin_verification", "name": "TIN verification", "category": "identity", "actionKey": "kyb_tin_verification", "priceKobo": 100000, "enabled": true, "required": true },
{ "moduleId": "scuml", "name": "SCUML registration", "category": "identity", "actionKey": "kyb_scuml", "priceKobo": 0, "enabled": false, "required": false }
]
}
}
Returns a detailed cost breakdown based on the widget’s current module configuration: the session base fee plus the per-verification cost of every enabled module. The
breakdown array contains one entry for each of the 19 modules (enabled or not).
Requires Authorization: Bearer $TOKEN.
Path parameters
string
required
The widget ID.
curl https://api.vouchmark.com/v1/kyb/widgets/wgt_aBcD.../estimate \
-H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"widgetId": "wgt_aBcD...",
"currency": "NGN",
"sessionBaseKobo": 50000,
"perVerificationKobo": 1250000,
"totalPerVerificationKobo": 1300000,
"enabledCount": 8,
"breakdown": [
{ "moduleId": "business_profile", "name": "Business profile", "category": "business", "actionKey": "kyb_business_profile", "priceKobo": 0, "enabled": true, "required": true },
{ "moduleId": "cac_verification", "name": "CAC verification", "category": "identity", "actionKey": "kyb_cac_verification", "priceKobo": 150000, "enabled": true, "required": true },
{ "moduleId": "tin_verification", "name": "TIN verification", "category": "identity", "actionKey": "kyb_tin_verification", "priceKobo": 100000, "enabled": true, "required": true },
{ "moduleId": "scuml", "name": "SCUML registration", "category": "identity", "actionKey": "kyb_scuml", "priceKobo": 0, "enabled": false, "required": false }
]
}
}
totalPerVerificationKobo equals sessionBaseKobo + perVerificationKobo, where perVerificationKobo sums the priceKobo of enabled modules. The example trims the breakdown array; the live response lists all 19 modules.
All prices are in kobo (1 NGN = 100 kobo). Divide by 100 for naira values.