What you can build
Every check covers an AI document scan, selfie face match, liveness detection and AML screening (PEP, sanctions and adverse media). Your system starts the check, your customer completes it on their phone or in your page, and the result comes back to your code.
Customer onboarding
Verify new customers inside your own sign-up or application flow, then unlock the account when the webhook says approved.
CRM and back-office triggers
Start a check when a lead, matter or listing is created, keep the verification id on the record and file the PDF report automatically.
Marketplace and platform checks
Verify sellers, hosts or buyers before they list, trade or withdraw, with your own reference on every check.
Repeat checks
Send a new ID check to an existing customer when their details change, and read every result back with the list endpoint.
Three ways to integrate
Pick one, or combine them. Most teams create checks with the API and show them with the SDK.
Quickstart in 5 steps
- 1Sign up and choose the Growth planAPI access, test keys and test mode are included with the Growth plan ($299/month, 75 checks included). Pay As You Go and Business accounts do not include API access.
- 2Create test keysIn API Keys, create a test secret key (ais_test_) and, for the SDK, a test publishable key (ais_pk_test_).
- 3Create a verificationPOST /api/v1/verifications from your server. You get a verification_url and a client_token.
- 4Show the checkMount the SDK with the client_token, or send the customer the link. On the TEST page you pick the outcome.
- 5Receive the webhook, then go liveVerify the AIS-Signature header, handle the event, then switch to live keys and set your Allowed domains.
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
}'All guides
- Quickstart →Growth plan to your first verification and webhook in five steps.
- API reference →Every endpoint, parameter, response and error code.
- Webhooks →Events, the signed envelope, signature checks in five languages and retries.
- SDK and embeds →Drop-in embed for HTML, React, Next.js, WordPress, Shopify and site builders.
- Test mode →Test mode on the Growth plan: simulated outcomes, free test checks and what is charged.
- API integration overview →The plain-English version for business owners and managers.
API basics
| Detail | |
|---|---|
| Base URL | https://portal.australianidentitysolutions.com.au |
| Authentication | Secret key as Authorization: Bearer ais_live_... or ais_test_... (the older x-api-key header still works). Server only. |
| Browser keys | Publishable keys ais_pk_live_ / ais_pk_test_ and one-hour client tokens ais_ct_. They can never read results. |
| Format | JSON in snake_case. Timestamps are Unix seconds. Every response has a Request-Id header. |
| Errors | { error: { type, code, message, param } } with the matching HTTP status. |
| Idempotency | Send an Idempotency-Key header on POST requests. The same key and body within 24 hours returns the first response. |
| Rate limit | 100 requests per minute per account and mode. A 429 response carries Retry-After (seconds). |
| Spec | OpenAPI 3.1 at /api/v1/openapi.json |
Plans and test mode
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.