Skip to main content
This guide gets you from zero to a verified company with a Vouchmark Score. You can do every step in the dashboard or via the API — both paths are shown.

1. Create an account

1

Sign up

Call POST /v1/signup (or sign up at vouchmark.com). The API emails a six-digit verification code and returns { "success": true, "data": { "requiresVerification": true, "userId": "usr_..." } }. No tokens are issued yet.
curl -X POST https://api.vouchmark.com/v1/signup \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"••••••••","name":"Ada"}'
2

Verify your email

Submit the code with POST /v1/verify-email. You cannot log in until the email is verified — logging in early returns 403 with data.requiresVerification: true and re-sends the code.
curl -X POST https://api.vouchmark.com/v1/verify-email \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","code":"123456"}'
3

Log in (API only)

Call POST /v1/login. On success it sets httpOnly session cookies (token, refreshToken, and a non-httpOnly vm_session). The JSON body confirms success but contains no tokens. For server-to-server calls, read the token cookie value and send it as Authorization: Bearer <token> on later requests. The access token lives ~15 minutes; refresh with POST /v1/refresh-token.
curl -i -X POST https://api.vouchmark.com/v1/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"••••••••"}'
See Authentication for the full cookie, Bearer, and refresh flow.

2. Claim a company

A “company” in Vouchmark is keyed by RC number (or business name registration). Claiming a company links it to your account and lets you run verifications against it.
Go to Companies New enter your RC number. We auto-fill name, registration date, and directors from CAC.
You’ll get an OTP at the registered company contact. Confirm it via POST /v1/verify-claim-otp to take ownership.

3. Run verifications

Once a company is claimed, kick off the four checks that make up a Vouchmark Score.
Returns directors, share capital, registration status. See Company (CAC) Verification.
Looks up the Tax Identification Number via the JTB resolver and matches the taxpayer name. See Tax (FIRS TIN) Verification.
Reads transaction history and matches the account name. See Bank Verification.
Confirms each director/shareholder with government ID. See Shareholders.

4. Read the score

The Vouchmark Score is computed automatically as verifications complete. Pull it from the dashboard or:
curl https://api.vouchmark.com/v1/dashboard/vouchmark \
  -H "Authorization: Bearer $TOKEN"
A company at 100 has cleared every check. Below 60 you should treat results as preliminary.

5. Publish a Trust Badge

A verified company can mint a public Trust Badge — a JWT-signed badge you embed on the company website. Anyone can hit GET /v1/trust-badge/verify?token=... to confirm it.

Next

Set up Smart Sentinel

Continuous monitoring after verification.

Browse the API Reference

Every endpoint, with examples.