VeroID Documentation

Base URL: https://api.veroid.com.au

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

Verify Document

Verify an identity document against the DVS.

POST /v1/verify

Request Headers

Header	Required	Description
`Content-Type`	Yes	Must be `application/json`
`X-API-Key`	Yes	Your API key

Common Request Fields

Field	Type	Required	Description
`documentType`	string	Yes	One of: drivers_licence, passport, medicare, visa, birth_certificate, citizenship
`givenName`	string	Yes	First name (max 100 chars)
`familyName`	string	Yes	Last name (max 100 chars)
`dateOfBirth`	string	Yes	Format: YYYY-MM-DD

Response

{
  "success": true,
  "verificationId": "ver_abc123xyz",
  "documentType": "drivers_licence",
  "status": "success",
  "match": true,
  "responseCode": "Y",
  "message": "Document verified - all details match",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "environment": "live"
}

Response Codes

Code	Status	Meaning
`Y`	success	Document verified - all details match
`N`	failed	Document not verified - details do not match
`D`	failed	Document not found in registry
`S`	failed	Document found but details do not match
`E`	error	System error - please retry
`U`	error	Unable to verify - service unavailable

Get Verification

Retrieve details of a previous verification.

GET /v1/verify/:id

List Verifications

List your recent verifications.

GET /v1/verify

Query Parameters

Parameter	Default	Description
`limit`	20	Max results (1-100)
`offset`	0	Pagination offset

Health Check

Check API status. No authentication required.

GET /health

API Reference