Product & API Documentation

WorkClear supports both non-technical operations teams and developer integrations. Test licence coverage in the dashboard, inspect API response shapes, or verify/search via API across 8 states with 1.1M licence records across building and trades, real-estate, and current security coverage.

API Use Cases

API use cases and coverage

Base URLhttps://www.workclear.com.au/api

Test coverage first

Use web search, JSON previews, and the status page to confirm the licence categories you need.

Try search

Run an API evaluation

Use one test key for 25 single-record requests over seven days, then choose a production plan.

Start API trial

Build server-side

Keep API keys out of client code and call WorkClear from your own backend service.

Authentication

Quick Start

Get your first licence-verification response in under two minutes.

Create an account

Get your API key

Generate a key from your dashboard. Test keys start with wc_test_ and production keys start with wc_live_.

Make your first request

Your first API call

curl "https://www.workclear.com.au/api/v1/verify?licence_number=54898&state=QLD" \
  -H "x-api-key: wc_test_your_api_key_here"

Authentication

All API v1 endpoints require authentication. Pass your API key via the x-api-key request header.

Header Authentication (recommended)

x-api-key header

curl "https://www.workclear.com.au/api/v1/verify?licence_number=54898&state=QLD" \
  -H "x-api-key: wc_live_your_api_key_here"

Security tip: Never expose your API key in client-side code. Always call the WorkClear API from your backend server.

API Key Format

Prefix	Description
wc_live_	API key — requests count against its trial or production-plan quota

Unauthenticated Endpoints

The following endpoints do not require an API key:

GET /api/status— System health check

Dashboard

Built for quick manual verification and integration testing. Search current coverage, inspect source fields, and compare the dashboard result with the `/api/v1/verify` response shape before wiring checks into your own system.

Verify Console

Test a licence type before you build against it

The dashboard is the quickest way to confirm whether WorkClear covers a register, what the official source publishes, and what your API integration should expect for a matching licence.

Search by licence number, name, or ABN across contractor, real-estate, and security coverage.
Scope searches by state and category where the API needs source-family context, such as NSW Design and Building Practitioners.
Review status, class, expiry, source, and enriched fields before deciding how to map them in your platform.
Copy a representative API request or JSON response for backend implementation and QA.

Good fit for onboarding flows, contractor platforms, workforce systems, CRMs, and compliance tools that need programmatic licence checks.

Endpoint

/api/v1/verify

Mode

Response preview

{

"status": "active",

"state": "QLD",

"licence_number": "15427909",

"valid_currently": true

}

GET request

state, sector, category where needed

Copy

What you test

Whether a licence type is covered, which state/category parameters matter, and whether the record returns active, inactive, expired, or not found.

What you inspect

Licence type, authorised classes, expiry, source, address fields, ABN/ACN, and source-specific enrichment when published.

What you build

Use the copied request and response shape as a reference for backend onboarding, compliance decisions, and QA fixtures.

Search & Verify

Fast single-licence checks from the dashboard

Search by licence number, name, or ABN.
View status, licence class, state, and expiry in one result card.
Toggle between the UI summary, API response preview, and request example.

Search: QLD-DEMO-54898

JOHN EXAMPLE BUILDING PTY LTDActive

Licence: QLD-DEMO-54898

State: QLD

Class: Builder - Open

Expiry: 31 Jan 2028

API responseRequest

Bulk CSV

Upload contractor lists and verify them in batches

Business +

CSV processing pipeline

1. Upload filedone

2. Parse + validate rowsdone

3. Verify licencesrunning

218 / 320 rows processed

Post-run actions

Filter invalid/expiring rows
Download the verified CSV result set
Use the API for ongoing or higher-volume verification

Free search

Fast manual checks for occasional verification

Use the dashboard when you need to look up a licence quickly or test how a source is represented.

API path

Programmatic checks for onboarding and compliance systems

Use API keys when checks need to run inside your own product, system, or database process.

Try Verify Console View Plans

Verify Licence

GET/api/v1/verify

Look up a licence by its licence number. Returns full details including holder name, status, expiry date, data source, and any published register metadata. Searches across all current coverage by default. If an unscoped number matches more than one record, the response returns multiple_matches instead of selecting one silently. State-scoped exact checks can use source-specific freshness paths where available.

Canonical endpoint: /api/v1/verify. The legacy /api/verify alias remains available for compatibility.

Parameters

Parameter	Type	Required	Description
licence_number	string	Required	The licence number to verify
state	string	Optional	State code: QLD, NSW, VIC, SA, WA, ACT, NT, TAS. If omitted, one unique match is returned normally and ambiguous numbers return multiple_matches. Required for QLD QBCC live exact fallback.
sector	string	Optional	"contractor" (default), "real_estate", or "security". Real-estate checks are live for VIC, NSW, QLD, WA, ACT, NT, and TAS; security coverage is source-specific, starting with QLD Security.
category	string	Optional	Optional specialised source category. Use "designer" or "nsw_dbp" for NSW Design and Building Practitioners records, or "owner_builder" for NSW Owner Builder Permit records.

Sector Values

Choose the sector that matches the register being checked. Security is a separate sector from contractor coverage; current security checks are live for QLD security employee and firm records.

Supported sector values

[
  {
    "sector": "contractor",
    "use_for": "Building, trade, construction, plumbing, electrical, and related contractor registers",
    "state_guidance": "QLD, NSW, VIC, SA, WA, ACT, NT, TAS where live"
  },
  {
    "sector": "real_estate",
    "use_for": "Property, agent, salesperson, resident letting, and real-estate business checks",
    "state_guidance": "VIC, NSW, QLD, WA, ACT, NT, and TAS"
  },
  {
    "sector": "security",
    "use_for": "Security employee and security provider firm checks",
    "state_guidance": "QLD currently"
  }
]

Request

Verify a licence

curl -X GET "https://www.workclear.com.au/api/v1/verify?licence_number=QLD-RE-DEMO-1005023&state=QLD&sector=real_estate" \
  -H "x-api-key: wc_live_your_api_key_here"

Security Request Example

For QLD security employee and firm checks, pass sector=security and state=QLD.

Verify a QLD security licence

curl -X GET "https://www.workclear.com.au/api/v1/verify?licence_number=10022&state=QLD&sector=security" \
  -H "x-api-key: wc_live_your_api_key_here"

Specialised NSW Category Examples

NSW Design and Building Practitioners and NSW Owner Builder Permit records share state=NSW and sector=contractor, so they are opt-in through category=designer, category=nsw_dbp, or category=owner_builder. Ordinary NSW contractor checks do not return these specialised rows unless the category is provided.

Verify a NSW design practitioner

curl -X GET "https://www.workclear.com.au/api/v1/verify?licence_number=DEP0002044&state=NSW&sector=contractor&category=designer" \
  -H "x-api-key: wc_live_your_api_key_here"

Verify a NSW owner-builder permit

curl -X GET "https://www.workclear.com.au/api/v1/verify?licence_number=429206P&state=NSW&sector=contractor&category=owner_builder" \
  -H "x-api-key: wc_live_your_api_key_here"

State Scope and Live Fallbacks

Licence numbers are not globally unique across Australian registers. For broad discovery you can omit state; WorkClear returns multiple_matches when more than one visible record shares the number. Production exact checks should pass both sector and state whenever known. QLD QBCC contractor checks use the local WorkClear dataset first; when a scoped exact lookup misses, WorkClear may run a live QBCC exact check and cache a positive result.

Response

200 OK — Licence found

{
  "status": "active",
  "sector": "contractor",
  "state": "NSW",
  "licence_number": "NSW-DEMO-401328C",
  "licensee_name": "Demo Electrical Services Pty Ltd",
  "abn": "00 000 000 000",
  "acn": null,
  "business_address": "SEVEN HILLS NSW 2147",
  "licence_type": "Contractor",
  "financial_category": null,
  "conditions": null,
  "issue_date": "2022-07-06",
  "expiry_date": "2027-06-30",
  "licence_classes": [
    {
      "class": "Electrician",
      "code": "HBS_CON_Electrician",
      "status": "Current",
      "expiry_date": "2027-06-30"
    }
  ],
  "licence_details": {
    "source_licence_type": "Contractor Licence",
    "licence_term": "5 years"
  },
  "source": "NSW Fair Trading",
  "valid_currently": true,
  "source_absent_at": null
}

200 OK — Multiple matches

{
  "status": "multiple_matches",
  "sector": "contractor",
  "licence_number": "12345",
  "count": 2,
  "states": ["NSW", "TAS"],
  "matches": [
    {
      "status": "active",
      "sector": "contractor",
      "state": "NSW",
      "licence_number": "12345",
      "licensee_name": "Example Licence Holder",
      "licence_type": "Qualified Supervisor",
      "valid_currently": true,
      "source": "NSW Fair Trading"
    },
    {
      "status": "active",
      "sector": "contractor",
      "state": "TAS",
      "licence_number": "12345",
      "licensee_name": "Example Licence Holder",
      "licence_type": "Electrical / Electrician",
      "valid_currently": true,
      "source": "TAS Consumer Affairs"
    }
  ],
  "message": "Multiple licence records were found. Pass state to verify a single record."
}

200 OK — Licence not found

{
  "status": "not_found",
  "live_lookup": {
    "provider": "qld_qbcc",
    "attempted": false,
    "persisted": false,
    "status": "skipped_state_required",
    "durationMs": 0,
    "message": "Pass state=QLD and sector=contractor to enable QBCC live exact lookup."
  }
}

Field	Type	Description
status	string	"active", "expired", "inactive", "unknown", "source_absent", "multiple_matches", or "not_found"
state	string	Australian state code (QLD, NSW, VIC, etc.)
licence_number	string	The licence number
licensee_name	string	Name of the licence holder
abn	string \| null	Australian Business Number
acn	string \| null	Australian Company Number
business_address	string \| null	Published business or register address, where available
licence_type	string \| null	Source-published licence, instrument, or category label
financial_category	string \| null	Financial category where published by the source
conditions	string \| null	Overall licence conditions published by the source, where available
licence_classes	array	Authorised work classes or scopes, including source codes, status, dates, and class conditions where published
licence_details	object	Explicitly allowlisted source-specific licence type/subtype, scope, credential, compliance, permit, and register details
issue_date	string \| null	Licence issue date (YYYY-MM-DD)
expiry_date	string \| null	Licence expiry date (YYYY-MM-DD)
source	string	Data source (e.g. "QBCC Licensed Contractors Register")
valid_currently	boolean	False when expired, inactive, unknown, or absent from the latest source refresh
source_absent_at	string \| null	When the record was first missing from a completed source refresh
live_lookup	object \| undefined	Present when a source-specific live lookup was attempted, skipped, or unavailable
count	number \| undefined	Number of records when status is "multiple_matches"
states	string[] \| undefined	Matching states when status is "multiple_matches"
matches	array \| undefined	Normalized matching records when status is "multiple_matches"

Licence Type and Classes

WorkClear preserves the wording published by each official register. Different states place the useful authorisation signal in different fields, so national integrations should not rely on licence_type = "Electrician" alone.

Use licence_type as the source's licence or instrument label, and use licence_classes as the published classes or scopes where that register exposes them. An empty licence_classes array does not by itself mean the licence is not electrical; some registers express the relevant authorisation in licence_type.

Source-Specific Licence Details

The licence_details object preserves material regulator-specific facts that do not fit the national baseline. Depending on the source, this can include type and subtype codes, term, area, register classification, endorsements, restrictions, limitations, credential and automatic deemed registration flags, compliance summaries, permit work sites, and the source publication date.

The object is always present and may be empty. WorkClear does not return raw source payloads, internal source IDs, scraper or reconciliation metadata, contact details, or geographic coordinates.

Electrical Checks by State

State	Where the electrical signal usually appears
NSW	Usually in licence_classes, for example Electrician.
ACT	licence_type may be Electrician, while licence_classes gives the class or scope, for example Class 2 - Unrestricted.
VIC	Often in licence_type, for example Registered Electrical Contractor, Licensed Electrical Worker, or Licensed Electrical Inspector.
WA	Often in licence_type, for example Electrician or Electrician's Training Licence.
NT	Often in licence_type, including restricted, unrestricted, mechanic, and fitter wording.
TAS	Both fields can matter, for example an electrical type plus Practitioner or Contractor class.
SA	Current live SA coverage is active Consumer and Business Services PGE and Builder/BLD records; assess the returned type/class values and active status.
QLD electrical	Not supported in public WorkClear verification. QLD building/trades, real-estate, and security coverage remain separate.

Electrical Field Examples

These examples show field placement across registers. Always evaluate the actual values returned for the licence being checked.

Illustrative electrical field patterns

[
  {
    "state": "NSW",
    "licence_type": "Contractor",
    "licence_classes": [{ "class": "Electrician" }]
  },
  {
    "state": "ACT",
    "licence_type": "Electrician",
    "licence_classes": [{ "class": "Class 2 - Unrestricted" }]
  },
  {
    "state": "VIC",
    "licence_type": "Registered Electrical Contractor",
    "licence_classes": []
  },
  {
    "state": "WA",
    "licence_type": "Electrician",
    "licence_classes": [],
    "licence_details": {
      "source_licence_type_code": "EL",
      "source_licence_subtype": "Individual",
      "source_licence_subtype_code": "I"
    }
  },
  {
    "state": "SA",
    "licence_type": "PGE",
    "licence_classes": [{ "class": "PGE" }]
  },
  {
    "state": "TAS",
    "licence_type": "Electrical / Electrician",
    "licence_classes": [{ "class": "Practitioner" }]
  }
]

Recommended Matching Logic

Require status = "active" and valid_currently = true.
Evaluate both licence_type and every licence_classes[].class.
Apply state-specific rules for accepted roles and scopes.
Treat restricted, unrestricted, provisional, training, worker, and contractor labels according to your policy.

Search Licences

GET/api/v1/search

Search for licences by name, ABN, or supported sector-specific fields. Supports state filtering, sector selection, and pagination.

Canonical endpoint: /api/v1/search. The legacy /api/search alias remains available for compatibility.

Parameters

Parameter	Type	Required	Description
q	string	Required	Search query — name, holder name, or ABN depending on sector
state	string	Optional	Filter by state (QLD, NSW, VIC, SA, WA, ACT, NT, TAS)
type	string	Optional	"name", "abn", or "licence_type" (auto-detected if omitted)
sector	string	Optional	"contractor" (default), "real_estate", or "security". Real-estate checks are live for VIC, NSW, QLD, WA, ACT, NT, and TAS; security coverage is source-specific, starting with QLD Security.
limit	integer	Optional	Max results to return (default: 10, max: 100)
include_absent	boolean	Optional	Set to "true" to include records absent from the latest source refresh. Hidden by default.

Request

Search by name

curl -X GET "https://www.workclear.com.au/api/v1/search?q=Demo%20Property&state=QLD&type=name&sector=real_estate&limit=5" \
  -H "x-api-key: wc_live_your_api_key_here"

Response

200 OK

{
  "count": 3,
  "results": [
    {
      "state": "QLD",
      "licence_number": "QLD-DEMO-54898",
      "licensee_name": "Demo Plumbing Services Pty Ltd",
      "abn": "00 000 000 000",
      "licence_type": "Business",
      "conditions": null,
      "licence_classes": [{ "class": "Plumbing and Drainage" }],
      "licence_details": {},
      "expiry_date": null
    },
    {
      "state": "NSW",
      "licence_number": "NSW-DEMO-123456C",
      "licensee_name": "Harbour Electrical Group Pty Ltd",
      "abn": "11 111 111 111",
      "licence_type": "Business",
      "conditions": null,
      "licence_classes": [{ "class": "Electrician" }],
      "licence_details": {},
      "expiry_date": "2027-03-15"
    }
  ]
}

Bulk Verify

POST/api/v1/verify/bulk

Verify multiple licence numbers in one request. Supports sector-aware batches, including VIC, NSW, QLD, WA, ACT, NT, and TAS real-estate lists and QLD security lists. An unscoped ambiguous item is returned with status multiple_matches.

The legacy /api/verify/bulk path remains available for existing integrations.

Parameters

Parameter	Type	Required	Description
licences	string[]	Required	Array of licence numbers to verify (max 100 per request)
state	string	Optional	Optional state filter. Ambiguous unscoped numbers return multiple_matches. Use VIC, NSW, QLD, WA, ACT, NT, and TAS for current real-estate coverage and QLD for current security coverage.
sector	string	Optional	"contractor" (default), "real_estate", or "security".
category	string	Optional	Optional batch-wide specialised source category. Use "designer" or "nsw_dbp" for NSW Design and Building Practitioners records, or "owner_builder" for NSW Owner Builder Permit records.

Request

Bulk verify QLD security licences

curl -X POST "https://www.workclear.com.au/api/v1/verify/bulk" \
  -H "x-api-key: wc_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "sector": "security",
    "state": "QLD",
    "licences": ["10022"]
  }'

Response

200 OK

{
  "summary": {
    "total": 1,
    "found": 1,
    "multiple_matches": 0,
    "not_found": 0,
    "errors": 0,
    "processing_time_ms": 182
  },
  "results": [
    {
      "licence_number": "10022",
      "status": "found",
      "data": {
        "status": "active",
        "sector": "security",
        "state": "QLD",
        "licence_number": "10022",
        "licensee_name": "Published security licence holder",
        "licence_type": "Security Provider",
        "source": "Queensland Office of Fair Trading Security Providers Register"
      }
    }
  ]
}

Data Coverage

GET/api/v1/coverage

Returns the product-safe source-family coverage contract for a sector, while retaining the original state, source, record-count, and freshness fields for compatibility.

Request

Get coverage

curl -X GET "https://www.workclear.com.au/api/v1/coverage" \
  -H "x-api-key: wc_live_your_api_key_here"

Response

200 OK

{
  "coverage_source": "source_intelligence_public_snapshot",
  "contract_version": "2026-04-24",
  "snapshot_timestamp": "YYYY-MM-DDTHH:mm:ssZ",
  "sector": "contractor",
  "total_records": 903442,
  "states_covered": 8,
  "families_covered": 13,
  "states": [
    {
      "state": "ACT",
      "sector": "contractor",
      "source": "ACT Construction Occupations Registrar",
      "source_url": "https://...",
      "records": 23704,
      "last_updated": "YYYY-MM-DD",
      "data_as_of": null,
      "notes": "ACT construction coverage is live.",
      "family_id": "ACT",
      "label": "ACT construction occupations",
      "status": "live",
      "confidence": "high",
      "can_verify": true,
      "public_limitations": []
    },
    {
      "state": "QLD",
      "sector": "contractor",
      "family_id": "QLD-ELECTRICAL-APPIAN",
      "source": "Queensland electrical licensing register",
      "records": 11049,
      "status": "blocked",
      "confidence": "limited",
      "can_verify": false,
      "public_limitations": ["Not available for public verification yet."]
    },
    ...
  ]
}

Current Coverage

This table summarises the main state coverage used by contractor-first API examples. For the live sector matrix, including real-estate and security source families, use the Status page or the coverage endpoint response.

State	Records	Source	Status
QLD	120K+	QBCC	Live
NSW	358K+	NSW Fair Trading	Live
VIC	48K+	VBA / ESV	Live
SA	35K+	CBS active PGE + Builder/BLD slices	Live
WA	92K+	WA Building Commission	Live
ACT	23K+	ACT Construction Occupations	Live
NT	13K+	NT Licensing	Live
TAS	14K+	CBOS Tasmania	Live

Need a source we don't cover yet?

Send us the register name, state, licence type, and a few sample licence numbers. If the official source is workable, we can assess it for onboarding.

Request a data source

Health Check

GET/api/healthNo auth required

Minimal service health endpoint. Use this for uptime probes and infrastructure monitoring. This is not a licence lookup endpoint.

Request

Service health check

curl -X GET "https://www.workclear.com.au/api/health"

Response

200 OK

{
  "status": "ok"
}

System Status

GET/api/statusNo auth required

Public system and data-status snapshot. Returns monitored state health and record coverage. No authentication required. For simple uptime checks, use /api/health.

Request

System health check

curl -X GET "https://www.workclear.com.au/api/status"

Response

200 OK

{
  "status": "operational",
  "badge": { "label": "Operational", "color": "green" },
  "timestamp": "2026-05-28T12:00:00.000Z",
  "policyVersion": "2026-05-28",
  "summary": {
    "monitoredStates": 8,
    "operationalStates": 8,
    "degradedStates": 0,
    "totalRecords": 1086881
  },
  "states": [
    {
      "state": "SA",
      "health": "operational",
      "records": 35056,
      "lastUpdated": "YYYY-MM-DDTHH:mm:ss.sssZ"
    },
    {
      "state": "QLD",
      "health": "operational",
      "records": 120799,
      "lastUpdated": "YYYY-MM-DDTHH:mm:ss.sssZ",
      "note": "Queensland electrical licence checks are not supported in public WorkClear verification; QBCC contractor, real-estate, and QLD security coverage are separate."
    }
  ]
}

See current status on our Status Page.

Check Licence Status

GET/api/v1/status

Quick validity check — returns whether a licence is currently valid with a simple boolean is_valid flag. Lighter response than the full verify endpoint. If state is omitted and more than one record matches, the response returnsmultiple_matches with is_valid: null.

Naming note: /api/status is platform status, while /api/v1/status is licence status.

Parameters

Parameter	Type	Required	Description
licence_number	string	Required	The contractor licence number
state	string	Optional	State code (QLD, NSW, VIC, etc.). Recommended for a single deterministic result; ambiguous unscoped numbers return multiple_matches.

Request

Quick status check

curl -X GET "https://www.workclear.com.au/api/v1/status?licence_number=54898&state=QLD" \
  -H "x-api-key: wc_live_your_api_key_here"

Response

200 OK — Licence found & valid

{
  "licence_number": "54898",
  "licensee_name": "CRAIG MAXWELL NIXON",
  "state": "QLD",
  "found": true,
  "is_valid": true,
  "status": "Current",
  "expiry_date": null
}

200 OK — Multiple matches

{
  "licence_number": "12345",
  "sector": "contractor",
  "state": "all",
  "found": true,
  "is_valid": null,
  "status": "multiple_matches",
  "count": 2,
  "states": ["NSW", "TAS"],
  "matches": [
    {
      "licence_number": "12345",
      "sector": "contractor",
      "licensee_name": "Example Licence Holder",
      "state": "NSW",
      "found": true,
      "is_valid": true,
      "status": "Current",
      "expiry_date": "2027-01-01",
      "source_absent_at": null
    },
    {
      "licence_number": "12345",
      "sector": "contractor",
      "licensee_name": "Example Licence Holder",
      "state": "TAS",
      "found": true,
      "is_valid": true,
      "status": "Active",
      "expiry_date": "2027-01-01",
      "source_absent_at": null
    }
  ],
  "message": "Multiple licence records were found. Pass state to check one record."
}

200 OK — Licence not found

{
  "licence_number": "INVALID123",
  "state": "all",
  "found": false,
  "is_valid": false,
  "message": "No licence found"
}

API Usage

Standard API plans are for your own business use. Call the API from your backend to verify licences inside onboarding, compliance, marketplace, CRM, portal, or back-office systems.

Included in standard API plans

Use licence checks inside your own product or internal system.
Show verification results to your own users or customers as part of your normal service.
Store results for reasonable audit, support, and compliance purposes.

Requires a separate agreement

Reselling, white-labelling, or syndicating WorkClear-powered checks.
Offering licence verification as a standalone third-party product, widget, or data service.
Bulk redistributing results or building a substitute licence database from API output.
Formal SLA, procurement, or custom source onboarding commitments.

If your platform needs Scale, Enterprise, partner, reseller, white-label, SLA, or custom source terms, contact us and we can set up the right commercial API agreement.

Rate Limits

API calls are rate-limited based on your plan. Monthly API limits reset on the 1st of each month. Web lookups on workclear.com.au are included for validating source coverage before integration, with anti-abuse limits.

Plan	API Calls	Price	Best For
Free	One-time 25-call API evaluation	$0	Manual search and integration testing
Pro	1,000 / month	$29/mo	Developers and small teams
Business	10,000 / month	$99/mo	Production API use and dashboard bulk CSV
Scale	Custom volume	Custom	Custom API volume
Enterprise	By agreement	Custom	SLA, partner, reseller, or custom source terms

Rate Limit Headers

When you exceed your rate limit, the API returns a 429 status with these headers:

Header	Description
X-RateLimit-Limit	Your monthly limit
X-RateLimit-Remaining	Remaining calls this month
Retry-After	Seconds until the monthly limit can be retried

Need higher limits? Compare plans or contact us for Scale or Enterprise pricing.

Error Codes

The API uses standard HTTP status codes. Versioned errors retain the human-readable error field and add a stable code plus request_id. The same request ID is returned in the X-Request-ID header.

Code	Meaning	What to Do
200	Success	Request succeeded. Check the response body: "not_found" means no match, while "multiple_matches" means state is required to select one record.
400	Bad Request	Invalid or missing parameters. Check that licence_number is provided and state is a valid code.
401	Unauthorized	Missing or invalid API key. Verify your x-api-key header.
429	Rate Limited	You've hit your monthly limit. Upgrade your plan or wait for the next monthly reset.
500	Server Error	Something went wrong on our side. Retry after a moment. If it persists, contact support.

Error Response Format

429 Too Many Requests

{
  "error": "Rate limit exceeded",
  "code": "quota_exceeded",
  "request_id": "wc_req_0123456789abcdef0123456789abcdef"
}

OpenAPI Schema

Use the OpenAPI 3.1 JSON contract to inspect endpoints, generate typed clients, or validate integration requests and responses.

Open the API schema

Python Integration

Use the standard requests library to integrate WorkClear into any Python application. Here's a ready-to-use client class:

workclear_client.py

import requests

class WorkClearClient:
    def __init__(self, api_key: str):
        self.api_key = api_key
        self.base_url = "https://www.workclear.com.au/api/v1"
        self.headers = {"x-api-key": api_key}

    def verify(self, licence_number: str, state: str = None):
        params = {"licence_number": licence_number}
        if state:
            params["state"] = state
        r = requests.get(f"{self.base_url}/verify", params=params, headers=self.headers)
        r.raise_for_status()
        return r.json()

    def search(self, query: str, state: str = None, limit: int = 10):
        params = {"q": query, "limit": limit}
        if state:
            params["state"] = state
        r = requests.get(f"{self.base_url}/search", params=params, headers=self.headers)
        r.raise_for_status()
        return r.json()

    def coverage(self):
        r = requests.get(f"{self.base_url}/coverage", headers=self.headers)
        r.raise_for_status()
        return r.json()

# Usage
client = WorkClearClient("wc_live_your_api_key_here")
result = client.verify("54898", state="QLD")
print(result)

No official Python package is required today. Use this client directly with your API key; we'll document a package if we add one.

JavaScript / Node Integration

Works with Node.js, Deno, Bun, or any runtime with fetch support. Here's a reusable client class:

workclear-client.js

class WorkClearClient {
  constructor(apiKey) {
    this.apiKey = apiKey;
    this.baseUrl = "https://www.workclear.com.au/api/v1";
  }

  async #request(endpoint, params = {}) {
    const url = new URL(`${this.baseUrl}${endpoint}`);
    Object.entries(params).forEach(([k, v]) => {
      if (v !== undefined && v !== null) url.searchParams.set(k, String(v));
    });
    const res = await fetch(url, {
      headers: { "x-api-key": this.apiKey }
    });
    if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
    return res.json();
  }

  verify(licenceNumber, state) {
    return this.#request("/verify", { licence_number: licenceNumber, state });
  }

  search(query, { state, limit } = {}) {
    return this.#request("/search", { q: query, state, limit });
  }

  coverage() {
    return this.#request("/coverage");
  }
}

// Usage
const client = new WorkClearClient("wc_live_your_api_key_here");
const result = await client.verify("54898", "QLD");
console.log(result);

No official npm package is required today. Use this client directly with your API key; we'll document a package if we add one.

Webhooks

Under evaluation

WorkClear is validating which licence changes, exception states, evidence, and delivery guarantees customers need before defining a webhook contract.

Share the workflow and event semantics your integration requires. Contact WorkClear

Ready to use the API?

Start with 25 API test requests over seven days. Choose Pro for a production key or Business for higher volume and dashboard bulk CSV.

Start API Trial Compare Plans Contact Sales