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 (required before production access)

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 dashboardto 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

Purchase early access at veroid.com.au (developer accounts require the one-time onboarding fee)
Visit dashboard.veroid.com.au and set your password using the email from your purchase
Sign in with email and password once dashboard access is granted

Step 2: Get a Test Key

Every verification hits the real Document Verification Service. There is no simulated mode. After VeroID approves your account for the DVS test hub, a test key (prefix: sk_test_) is issued in the dashboard.

Go to the API Keys section in your dashboard
Create or copy your test key
Send requests only to https://test-api.veroid.com.au

Keys only work on their matching endpoint. A sk_test_* key on api.veroid.com.au returns 403. See Authentication.

Step 3: Make Your First Request

Use a confirmed IVS test record from the DVS test records table. Each row includes the full request body and expected response code. Example (replace field values with a published test case):

curl -X POST https://test-api.veroid.com.au/v1/verify \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_test_your_key" \
  -d '{
    "documentType": "drivers_licence",
    "givenName": "...",
    "familyName": "...",
    "dateOfBirth": "1990-01-15",
    "licenceNumber": "...",
    "stateOfIssue": "NSW",
    "cardNumber": "...",
    "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": "test",
  "requestId": "req_xyz789"
}

Step 4: Go Live

Live access is granted by VeroID, not self-serve. Once your integration works against the DVS test hub, 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 with your sk_live_* key
Ensure you have sufficient credit balance
Each live verification deducts 1 credit (Y, N, or D outcomes; only system errors do not deduct)

Next Steps

Authentication - API key types and endpoint pairing
Document Types - Supported documents and fields
Test Environment - DVS test records and screening fixtures
API Reference - Complete endpoint documentation

Getting Started