Identity verification API for Australian businesses
Start an ID check from your own system with one API call. Show it in your page or email your customer the link, and a signed webhook tells you the result. API access is included with the Growth plan ($299/month).
- ✓ API, SDK, widget and test mode on the Growth plan
- ✓ No lock-in, cancel any time
- ✓ No setup fee
Quick answer
What is an identity verification API?
An identity verification API lets your own software start an ID check and get the result back without anyone logging in to a dashboard. With the Australian Identity Solutions API, your server sends one POST request, your customer scans their ID and takes a selfie in your page or from an emailed link, and a signed webhook tells your system when the check is approved or declined.
Last reviewed by the AIS Compliance Team. General information, not legal advice.
How it fits your workflow
Three steps, and your team never has to chase an ID document again.
- 1
Your system starts the check
Your CRM, onboarding form or back office calls POST /api/v1/verifications, with the customer's details and your own reference. Or the customer clicks the widget button on your website.
- 2
Your customer verifies
Show the check inside your page with the SDK, or let us email your customer a secure link. They scan their licence or passport and take a selfie. No app to download.
- 3
Your webhook gets the result
We POST a signed event to your endpoint as the check is created, started, sent to review, approved or declined. The event carries the full result, so your system can move the customer on straight away.
Everything your developer needs
Each piece has its own guide with copy-ready code.
REST API
Create, list, read and cancel checks, mint SDK tokens and download PDF reports from your server.
API reference →Webhooks
Seven signed events, retried for 24 hours if your system is down, with a delivery log and resend button.
Webhooks guide →Website SDK
One script shows the check inline or in a pop-up on your site. Guides for HTML, React, Next.js, WordPress and Shopify.
SDK guides →Test mode
Test keys on the Growth plan, with free test checks. You choose approve, decline, review or abandon, and everything else behaves like live.
How test mode works →Where businesses plug it in
CRM or onboarding form
A new lead or client fills in your form, your server creates the check with their reference, and the result lands back on their record when the webhook arrives. Nobody re-keys details.
Real estate or legal practice software
Start an ID check when a matter or listing is opened, keep the verification id with the file, and download the PDF report for your customer due diligence records.
A lender's application flow
Trigger verification when an application is submitted and hold the approval step until the webhook says the check is approved, or route declined and review results to a person.
Marketplace sign-up
Verify sellers or buyers before they can list, trade or withdraw. Embed the check in your sign-up page with the SDK, or drop the widget onto the account page with no back-end work.
Create a check, then receive the result
All requests go to our portal over HTTPS with JSON bodies. Send your secret key as a Bearer token.
1. Create a verification
Every field is optional. Pass the customer's email and we email them their link, or set send_email to false and show the check in your own page. The response includes the customer link and a client_token for the SDK.
curl https://portal.australianidentitysolutions.com.au/api/v1/verifications \
-H "Authorization: Bearer $AIS_SECRET_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order_1234-verify" \
-d '{
"customer": { "email": "jane@example.com", "name": "Jane Citizen" },
"reference": "order_1234",
"metadata": { "plan": "gold" },
"send_email": false
}'{
"id": "cmi4x0abc0001xyz",
"object": "verification",
"livemode": false,
"status": "pending",
"result": null,
"reference": "order_1234",
"metadata": {
"plan": "gold"
},
"customer": {
"email": "jane@example.com",
"name": "Jane Citizen",
"phone": null
},
"document": null,
"checks": null,
"verification_url": "https://portal.australianidentitysolutions.com.au/v/cmi4x0abc0001xyz",
"redirect_url": null,
"report_url": null,
"source": "api",
"created_at": 1763540000,
"started_at": null,
"completed_at": null,
"expires_at": 1764144800,
"client_token": "ais_ct_eyJ2IjoiY21pNHgwYWJjMDAwMXh5eiJ9.EXAMPLE_SIGNATURE",
"client_token_expires_at": 1763543600
}2. Receive the webhook and verify the signature
Add your endpoint in the dashboard and choose its events. Each delivery has an AIS-Signature header: a timestamp and an HMAC-SHA256 of the timestamp and raw body, signed with your endpoint secret (whsec_...). The event carries the full verification, so there is no second call to make.
// Next.js route handler (app/api/ais-webhook/route.js). Any framework works,
// as long as you read the RAW body before parsing it.
import crypto from "node:crypto";
export async function POST(req) {
const rawBody = await req.text();
const parts = Object.fromEntries(
(req.headers.get("ais-signature") || "").split(",").map((p) => p.split("=", 2))
);
const t = Number(parts.t);
const expected = crypto
.createHmac("sha256", process.env.AIS_WEBHOOK_SECRET) // whsec_...
.update(`${t}.${rawBody}`)
.digest("hex");
const valid =
!!t && Math.abs(Date.now() / 1000 - t) <= 300 && // 5-minute tolerance
typeof parts.v1 === "string" && parts.v1.length === expected.length &&
crypto.timingSafeEqual(Buffer.from(parts.v1), Buffer.from(expected));
if (!valid) return new Response("Invalid signature", { status: 400 });
const event = JSON.parse(rawBody);
// event.type: "verification.completed", "verification.failed", ...
// event.data.object: the verification, same shape as GET /api/v1/verifications/{id}
// De-duplicate on event.id, update your CRM, unlock the account or flag it for review.
return new Response("ok");
}Show the check in your own page
The SDK puts the check inline or in a pop-up on your site. Your server passes it the client_token from step 1, so no secret ever reaches the browser.
<!-- Where the check appears -->
<div id="ais-verify"></div>
<script src="https://portal.australianidentitysolutions.com.au/sdk/v1/ais.js"></script>
<script>
// 1. Ask YOUR server for a client token (see "Server side" below).
fetch("/start-verification", { method: "POST" })
.then(function (r) { return r.json(); })
.then(function (data) {
// 2. Mount the check with it. Never put a secret key in a web page.
AIS.mount({
clientToken: data.client_token, // ais_ct_..., valid for 1 hour
container: "#ais-verify",
mode: "inline", // or "modal"
onComplete: function (r) {
// r = { id, status, result }. Confirm on your server before acting on it.
window.location = "/verified?id=" + encodeURIComponent(r.id);
},
onError: function (e) { console.error(e.code, e.message); }
});
});
</script>No developer? Paste the widget
One script tag adds a Verify Identity button that opens the check in a pop-up on your page, or in a new tab.
<script
src="https://portal.australianidentitysolutions.com.au/widget.js"
data-key="ais_pk_live_YOUR_PUBLISHABLE_KEY"
data-button-text="Verify Identity"
data-button-color="#0e7c66"
data-mode="modal"
data-reference="order_1234">
</script>- ✓Use a publishable key (ais_pk_live_ or ais_pk_test_). It can only start a check and can never read results, so it is safe in a web page.
- ✓To show the check inside your page, list your website under Allowed domains in the dashboard. The new-tab mode works without it.
- ✓Widget checks are not tied to a named customer, so pass your own reference, or create the check with the API to link it to a record.
- ✓You can also send links straight from the dashboard with no integration at all.
Build and test for free
Test mode is included with the Growth plan. Test checks are free of charge and never take a real ID.
- ✓Test keys start with ais_test_ (server) and ais_pk_test_ (website). Swap in live keys when you are ready, and nothing else in your code changes.
- ✓The customer link opens a clearly marked TEST page where you choose Approve, Decline, Needs review or Abandon.
- ✓The outcome runs through the same steps as a real check: statuses, webhooks to your test endpoints, team emails and a PDF report, all marked TEST.
- ✓Test and live data are kept apart. A test key never sees a live check.
What you get back
- status
- pending, in_progress, in_review, completed, expired, abandoned or canceled
- result
- approved or declined once completed, otherwise null
- document.type, document.country
- The ID document the customer used and where it was issued
- checks.document, checks.liveness
- passed, failed, review or not_run
- checks.face_match
- How the selfie matched the ID photo, with a 0 to 100 score
- checks.aml
- AML screening outcome (PEP, sanctions and adverse media), with the number of hits
- reference, metadata
- Your own id and key/values, returned on every read and webhook
- report_url
- The PDF audit report, downloadable with your secret key once completed
You and your team are also emailed when a check finishes, so the result is not lost if your webhook is down. Australian Government DVS checks of Australian driver licences and passports run as part of the check, included at no extra cost.
The full verification object →Built to keep keys and results private
Separate server and browser keys
Secret keys (ais_live_, ais_test_) create and read checks from your server. Publishable keys and one-hour client tokens only start or show a check and can never read results. Keys are stored hashed and can be revoked at any time.
Allowed domains
The check can only be embedded on websites you list in the dashboard. Once you list them, your publishable keys only start checks from those sites.
Signed, replay-safe webhooks
Every webhook carries a timestamped HMAC-SHA256 signature made with your own endpoint secret, so your system can reject anything forged or replayed.
More on how we handle data on the compliance page.
Same per-check pricing. No API fee.
API, SDK, widget, webhooks and test mode are included with the Growth plan only ($299/month, 75 checks included, then $3.99 a check). Pay As You Go and Business accounts use the dashboard and do not include API access.
Growth plan · includes API
$299/month
75 checks included each month ($3.99 a check), then $3.99 a check. REST API, webhooks, SDK and the website widget. No lock-in, cancel any time.
Test mode · Growth plan
Included
Create test keys and build your whole integration. Test checks are free of charge. Pay As You Go ($9.99 a check) and Business ($99/month) are dashboard plans and do not include API access.
Live checks are charged only when completed, approved or declined. Abandoned, expired and cancelled checks are free. A check in review is charged once, when it ends approved or declined. No GST is added. See full pricing
Related pages
- Developer documentation →Quickstart, API reference, webhooks, SDK and test mode.
- API quickstart →Your first verification and webhook in five steps.
- KYC for fintechs and online platforms →Verification for AUSTRAC-regulated fintechs, with the API built in.
- Identity verification pricing →First check free, then $9.99 a check, $99/month (20 checks) or $299/month with the API (75 checks).
Questions about the API
Build ID checks into your own system.
Choose the Growth plan, create your test keys and run your first test check in minutes.
Get API access with the Growth plan →