Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vouchmark.com/llms.txt

Use this file to discover all available pages before exploring further.

Every company in Vouchmark passes through the same five stages. The state lives on the company record itself, so you can resume a flow from any stage without losing context.

1. Unclaimed

A skeleton record pulled from CAC. Anyone can search for it; nobody owns it. Score is 0.

2. Claimed

A user proves ownership via the OTP sent to the company’s registered contact and links the company to their Vouchmark account. From this point the record is editable by the owner — directors, share capital, logo, socials, bank details — and verifications can be run.

3. Verifying

The record is owned, and at least one verification job is in flight or pending. CAC and FIRS TIN are kicked off automatically once a valid RC number is on file; bank, shareholder, and utility-bill checks require the owner to upload supporting documents. Each verification has its own pending flag on the company record (firsTinPending, cacertVerified, etc.) so the dashboard can render exactly which step is in flight.

4. Verified

The score has reached the threshold of the issuing band (default: 60 for partially_verified, 90 for verified). A Trust Badge can be minted. The company is publicly searchable.

5. Monitored

The owner has subscribed the company to Smart Sentinel. Verifications re-run on a schedule and external feeds are watched. A monitoring event of high severity can drop the company back to Verifying until the issue is resolved.

Resuming where you left off

Every stage exposes a “current step” derivation that the dashboard uses to render the right card. The API gives you the same information via GET /v1/dashboard/my-companies?id={companyId}:
{
  "company": {
    "id": "cmp_aBcD...",
    "active": true,
    "vouchmark_tools": {
      "vouch_mark": 60,
      "firstaxClearance_vr": true,
      "firsttin_pending": false,
      "cacert_verified": true,
      "activeBank": false,
      "shareHolderVerified": false
    },
    "tax": { "firsTin": "2522576963525", "firsttin_pending": false }
  }
}
Look at the vouchmark_tools flags to see which verifications have completed and which are still open.