VeroID Documentation

VeroID uses API keys for authentication. Each request must include a valid API key in the X-API-Key header.

API keys require a developer account. VeroID accounts come in two mutually exclusive types. A developer account gets API keys and pays a one-time onboarding fee. A dashboard account runs checks from the VeroID dashboard instead, pays no onboarding fee, and is never issued API keys. Requests authenticated as a dashboard account are rejected with 403. You choose at signup and can switch from Dashboard > Billing.

API Key Types

Sandbox Keys (`sk_sandbox_*`)

Provisioned automatically when a developer account is activated
Send requests to https://test-api.veroid.com.au
Return simulated responses — no real verification is performed
Don't deduct credits

Live Keys (`sk_live_*`)

Issued to you once your onboarding fee is settled and VeroID approves your account for production DVS — you can't create one before then
Send requests to https://api.veroid.com.au
Run real verifications against the Document Verification Service
Deduct 1 credit per verification (Y, N, or D outcomes)
Verification records are kept for audit purposes

Note: Live keys are rejected with 403 until the onboarding fee is paid and your account is approved, on every endpoint including test-api.veroid.com.au. Build your integration with a sandbox key while approval is pending.

Using API Keys

Testing with a sandbox key:

curl -X POST https://test-api.veroid.com.au/v1/verify \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_sandbox_your_api_key" \
  -d '{ ... }'

Running a real verification with a live key:

curl -X POST https://api.veroid.com.au/v1/verify \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_live_your_api_key" \
  -d '{ ... }'

Security Best Practices

Store Keys Securely

# Use environment variables
export VEROID_API_KEY="sk_live_..."

Never Expose Keys

Error: Never include API keys in client-side code, Git repositories, or public URLs.

Managing API Keys

Go to Dashboard > API Keys. The page only appears on developer accounts.
Click Create API Key
Choose the environment. Until your onboarding fee is paid and your account is approved for production DVS, only sandbox keys can be created — the live option appears after approval.
Copy the key immediately (it won't be shown again)

Authentication