Getting Started

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)
• A consent process for your end users that meets IVS requirements. See Consent & IVS obligations and IDMatch guidance for users

Step 1: Create Your Account

1. Sign up at dashboard.veroid.com.au/signup (developer accounts require the one-time onboarding fee)
2. Set your password from the email we send you
3. Sign in to the dashboard

Step 2: Complete IVS Registration

Before test or live verification access, complete the official IVS registration form. Developer accounts register as an Identity Service Provider. Select One Shot Ventures Pty Ltd on the official form, then confirm submission under Settings in the dashboard.

Open the IVS registration form

Step 3: Get a Test Key

Every verification hits the real official identity verification network. There is no simulated mode. After the developer onboarding fee is paid and test hub access is active, a test key (prefix: sk_test_) is issued in the dashboard.

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

Step 4: Make Your First Request

Use a confirmed IVS test record from the IVS 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 5: Go Live

Live access requires IVS registration verification, successful test-hub certification, and VeroID approval. Submit a go-live request from the dashboard once your integration works against the test verification hub. Include the government approval organisation code from your Attorney-General's Department notice (required on the request form). After we approve your account and promote it to live production verification:

1. Create a live key in the dashboard. The option unlocks on approval
2. Point your requests at https://api.veroid.com.au with your sk_live_* key
3. Ensure you have sufficient credit balance
4. Each live verification deducts 1 credit for success, identity no-match (failed with N or D), but not for invalid_input or system errors (error / S)

Next Steps

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