VeroID Documentation

This guide will help you set up your VeroID account and make your first identity verification request.

Prerequisites

An Australian business (ABN required)
A payment method for the one-time developer onboarding fee

This guide is for developer accounts. VeroID accounts come in two mutually exclusive types. Pick developer to get API keys and integrate, which carries a one-time onboarding fee. Pick dashboard to run checks by hand from the VeroID dashboard, which has no onboarding fee and no API keys. Dashboard accounts don't need this guide.

Step 1: Create Your Account

Visit dashboard.veroid.com.au
Choose the Developer account type
Sign in with email/password (or Google)
Your account will be activated automatically
Pay the one-time onboarding fee from Billing. Sandbox access works before you pay; a live key requires it.

Step 2: Generate a Sandbox Key

After your account is activated:

Go to the API Keys section in your dashboard
Create a sandbox key for testing (prefix: sk_sandbox_)

Note: Sandbox is the only environment available at first. A live key (prefix: sk_live_) is issued once VeroID approves your account for production DVS — see Step 4.

Warning: Keep your API keys secure! Never expose them in client-side code or public repositories.

Step 3: Make Your First Request

Test with Sandbox

Send sandbox requests to test-api.veroid.com.au. No credits are used. Use family name dvsmatch to guarantee a match result (Y):

curl -X POST https://test-api.veroid.com.au/v1/verify \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_sandbox_your_key" \
  -d '{
    "documentType": "drivers_licence",
    "givenName": "John",
    "familyName": "dvsmatch",
    "dateOfBirth": "1990-01-15",
    "licenceNumber": "1234567",
    "stateOfIssue": "NSW",
    "cardNumber": "1234567890",
    "consentAttestedAt": "2026-05-19T10:30:00Z",
    "consentVersion": "1.0"
  }'

Expected Response

{
  "success": true,
  "verificationId": "ver_abc123",
  "documentType": "drivers_licence",
  "status": "success",
  "match": true,
  "responseCode": "Y",
  "message": "The data in the request matches data held by the issuer",
  "timestamp": "2024-01-15T10:30:00Z",
  "environment": "sandbox",
  "requestId": "req_xyz789"
}

Step 4: Go Live

Live access is granted by VeroID, not self-serve. Once your integration works in sandbox, settle the onboarding fee and contact us to be assessed against the DVS access criteria. After we approve your account and promote it to production DVS:

Create a live key in the dashboard — the option unlocks on approval
Point your requests at https://api.veroid.com.au instead of https://test-api.veroid.com.au
Ensure you have sufficient credit balance
Each live verification deducts 1 credit (Y, N, or D outcomes — only system errors do not deduct)

Note: Until the onboarding fee is paid and your account is approved, live keys return 403 on every endpoint. Sandbox is the supported way to build in the meantime.

Next Steps

Authentication - Learn about API key management
Document Types - Explore supported documents
Sandbox Mode - Test edge cases and error handling
API Reference - Complete endpoint documentation

Getting Started