Skip to main content
GET
/
v1
/
kyb
/
applicants
/
{applicantId}
curl https://api.vouchmark.com/v1/kyb/applicants/app_aBcD... \
  -H "Authorization: Bearer $TOKEN"
{
  "success": true,
  "data": {
    "applicant": {
      "id": "app_aBcD...",
      "widgetId": "wgt_aBcD...",
      "environment": "live",
      "status": "approved",
      "subject": {
        "businessName": "Acme Trading Ltd",
        "registrationNumber": "RC123456",
        "tin": "12345678-0001",
        "email": "admin@acme.com",
        "phone": "+2348012345678",
        "jurisdiction": "NG",
        "industry": "fintech"
      },
      "referenceId": "your_ref_123",
      "riskScore": 92,
      "decisionReason": null,
      "moduleOrder": ["business_profile", "cac_verification", "tin_verification"],
      "totalSpentKobo": 200000,
      "startedAt": "2026-06-01T10:00:00Z",
      "submittedAt": "2026-06-01T10:25:00Z",
      "decidedAt": "2026-06-01T10:25:30Z",
      "createdAt": "2026-06-01T10:00:00Z",
      "updatedAt": "2026-06-01T10:25:30Z"
    },
    "runs": [
      {
        "id": "run_aBcD...",
        "applicantId": "app_aBcD...",
        "widgetId": "wgt_aBcD...",
        "moduleId": "cac_verification",
        "actionKey": "kyb_cac_verification",
        "status": "passed",
        "units": 1,
        "chargedKobo": 15000,
        "walletTransactionId": "txn_...",
        "score": 92,
        "result": { "companyName": "ACME TRADING LTD", "rcNumber": "RC123456", "status": "ACTIVE" },
        "errorMessage": null,
        "startedAt": "2026-06-01T10:10:00Z",
        "completedAt": "2026-06-01T10:10:03Z",
        "createdAt": "2026-06-01T10:10:00Z"
      }
    ]
  }
}
Returns the applicant record plus the array of verification runs that have executed for it. runs is empty until modules have run. Requires Authorization: Bearer $TOKEN.

Path parameters

applicantId
string
required
The applicant ID (starts with app_).
curl https://api.vouchmark.com/v1/kyb/applicants/app_aBcD... \
  -H "Authorization: Bearer $TOKEN"
{
  "success": true,
  "data": {
    "applicant": {
      "id": "app_aBcD...",
      "widgetId": "wgt_aBcD...",
      "environment": "live",
      "status": "approved",
      "subject": {
        "businessName": "Acme Trading Ltd",
        "registrationNumber": "RC123456",
        "tin": "12345678-0001",
        "email": "admin@acme.com",
        "phone": "+2348012345678",
        "jurisdiction": "NG",
        "industry": "fintech"
      },
      "referenceId": "your_ref_123",
      "riskScore": 92,
      "decisionReason": null,
      "moduleOrder": ["business_profile", "cac_verification", "tin_verification"],
      "totalSpentKobo": 200000,
      "startedAt": "2026-06-01T10:00:00Z",
      "submittedAt": "2026-06-01T10:25:00Z",
      "decidedAt": "2026-06-01T10:25:30Z",
      "createdAt": "2026-06-01T10:00:00Z",
      "updatedAt": "2026-06-01T10:25:30Z"
    },
    "runs": [
      {
        "id": "run_aBcD...",
        "applicantId": "app_aBcD...",
        "widgetId": "wgt_aBcD...",
        "moduleId": "cac_verification",
        "actionKey": "kyb_cac_verification",
        "status": "passed",
        "units": 1,
        "chargedKobo": 15000,
        "walletTransactionId": "txn_...",
        "score": 92,
        "result": { "companyName": "ACME TRADING LTD", "rcNumber": "RC123456", "status": "ACTIVE" },
        "errorMessage": null,
        "startedAt": "2026-06-01T10:10:00Z",
        "completedAt": "2026-06-01T10:10:03Z",
        "createdAt": "2026-06-01T10:10:00Z"
      }
    ]
  }
}
A run’s status is one of pending, passed, failed, or requires_review.