Test with Postman
Import a ready-made collection, set your API key once, and run requests in order.
sk_test_* or sk_live_* key into apiKey, save, then send requests. If the response is 401 with Missing API key, either no environment is selected or apiKey is still empty.The Postman pack mirrors the public developer API documented in the API reference. It includes verify, sessions, document extract, screening, monitoring, webhooks, health, and PDF report requests. Data residency is Australian hosted data; images you send stay in that environment.
Downloads
- VeroID Developer API collection (Postman v2.1 JSON)
- VeroID Sandbox environment (base URL
https://test-api.veroid.com.au, forsk_test_*keys) - VeroID Production environment (base URL
https://api.veroid.com.au, forsk_live_*keys)
Test and live keys use different base URLs. A key only works on its matching host; the wrong pairing returns 403 WRONG_API_ENDPOINT. See Authentication.
Setup steps
- Download the collection and the environment file for the hub you use (sandbox or production).
- In Postman, choose Import and select both JSON files (or drag them in).
- In the top-right environment dropdown, select VeroID Sandbox or VeroID Production (do not leave No Environment selected).
- Click the eye icon next to the environment name, set apiKey to your dashboard key (Current value), and save the environment.
- Optional: set formId on the collection variables to a published
ecfg_…id before running prefilled form session requests. - Run folders top to bottom. Collection test scripts store
verificationId,sessionId,screeningId, and other ids for chained calls.
Headers and auth
The collection uses API key auth: header X-API-Key with value {{apiKey}} from your environment. Create requests that support idempotency include an Idempotency-Key header with {{$guid}}.
Photo size (document extract)
The driver licence extract request sends front and back images as base64 inside JSON. The entire HTTP body must stay under about 6 MiB (6,291,456 bytes). Phone camera originals often exceed that when both sides are encoded. Before running extract in Postman, resize each photo to about 1600 px on the long edge, JPEG quality about 80, and aim for under 1 MB per file before base64. If you see 413 Request Entity Too Large, the body never reached the application. See Document extract errors.
Test data
The default verify request body uses official IVS test hub record DL01 from the test records table. Screening examples use sandbox trigger names such as screenclear (see test environment). Do not put real customer PII in shared workspaces.
What is not in this collection
- Subject browser flows (
/v1/hosted/sessions,/v1/embed/sessions,/v1/form-link/sessions) use session tokens in the browser, not your API key. - Internal admin routes, billing jobs, and the MCP streamable HTTP endpoint are excluded. Use MCP documentation for AI assistant integration on the test API.