API Reference

Base URLs

Live keys are only issued after VeroID approves your account for production DVS, and return 403 on every endpoint until then. See Authentication.

All requests must include the X-API-Key header.

Verify Document

Verify an identity document against official government records.

POST /v1/verify

Request Headers

Common Request Fields

Every request requires documentType, consentAttestedAt, and consentVersion, plus the document-specific fields - see Document Types for per-document schemas.

Response (POST /v1/verify)

The real-time verification result is returned in the response body. The status and match fields reflect the DVS outcome and are only available here - they are not stored or retrievable via the GET endpoints.

{
  "success": true,
  "verificationId": "ver_abc123xyz",
  "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:00.000Z",
  "environment": "live",
  "requestId": "req_xyz789"
}

When responseCode is N or D, an errors array may be present with field-level detail from the issuer. See Expanded Responses below.

DVS test environment records

For integration testing against the real DVS test hub (not the simulated sandbox), use the confirmed IVS/Fujitsu test records published on the Sandbox page. Each case includes the full request body and the expected responseCode: only records where both verification cycles matched the expected outcome are listed.

Requires a sk_test_* key and an account approved for the DVS test hub. Send requests to https://test-api.veroid.com.au/v1/verify. sk_live_* keys only work on https://api.veroid.com.au.

Expanded Responses

DVS expanded responses (VersionNumber=2) give field-level detail when a verification does not match or hits a data error. VeroID requests VersionNumber=2 on every verify call and passes expanded detail through in the errors array on POST /v1/verify.

When expanded responses appear

• responseCode is N (no match) or D (data error at the issuer)
• The document issuer supports VersionNumber=2 for that document type (most major issuers do; some may return only the primary code)
• DVS returns at most one expanded error per request - the first field the issuer flags

Y (match) responses do not include an errors array. S (system error) responses typically do not either.

errors entry schema

Example - no match (N)

{
  "success": true,
  "verificationId": "ver_abc123xyz",
  "documentType": "drivers_licence",
  "status": "failed",
  "match": false,
  "responseCode": "N",
  "message": "The data in the request does not match data held by the issuer",
  "errors": [
    { "source": "Issuer", "field": "FamilyName", "message": "Name does not match" }
  ],
  "timestamp": "2024-01-15T10:30:00.000Z",
  "environment": "live",
  "requestId": "req_xyz789"
}

Example - data error (D)

{
  "success": true,
  "verificationId": "ver_abc123xyz",
  "documentType": "drivers_licence",
  "status": "failed",
  "match": false,
  "responseCode": "D",
  "message": "A data error occurred at the issuer",
  "errors": [
    { "source": "DVS", "message": "Record not held at source" }
  ],
  "timestamp": "2024-01-15T10:30:00.000Z",
  "environment": "live",
  "requestId": "req_xyz789"
}

In sandbox, use the dvsnomatch and dvsdata family-name triggers to receive sample expanded errors - see Sandbox Mode.

POST response fields

DVS Response Codes

These are the only four codes returned by the DVS Hub (per DVS Interface Specification Table 22):

GET Endpoint Status Values

The GET /v1/verify/:id and GET /v1/verify endpoints return a status field representing the processing state of the request - not the match outcome, which is only in the real-time POST response.

Get Verification

Retrieve the processing state of a previous verification. The match result (match, responseCode, errors) is not stored and will not appear here - it is only available in the real-time POST response. See DVS T&Cs 12.5.

GET /v1/verify/:id

Response (GET /v1/verify/:id)

{
  "verificationId": "ver_abc123xyz",
  "documentType": "drivers_licence",
  "status": "completed",
  "environment": "live",
  "requestedAt": "2026-05-19T10:30:00.000Z",
  "completedAt": "2026-05-19T10:30:01.200Z"
}

If the verification encountered a system error, an error object is included:

{
  "verificationId": "ver_abc123xyz",
  "documentType": "drivers_licence",
  "status": "error",
  "environment": "live",
  "requestedAt": "2026-05-19T10:30:00.000Z",
  "completedAt": "2026-05-19T10:30:01.200Z",
  "error": {
    "code": "DVS_SYSTEM_ERROR",
    "message": "A system error occurred at the issuer or in the Hub"
  }
}

List Verifications

List your recent verifications.

GET /v1/verify

Query Parameters

Screening

Screen persons and organisations against sanctions, PEP, and optional adverse media. See Screening API for full documentation.

POST /v1/screening

Live screening is available after the developer onboarding fee is paid. DVS Manager approval is not required for screening endpoints.

Health Check

Check API status. No authentication required.

GET /health