Skip to content
New

Person Report API and New Zealand identity checks are now live.

See what's newarrow_forward
WatchEyeOnboarding & monitoring

Customer onboarding, screening and ongoing monitoring in one system, with real-time KYC and KYB alerts when a customer's risk changes.

Visit WatchEyearrow_forwardcheck_circleIncluded in the Global Data Portal
IDFEX ID CheckIdentity verification

One-to-one identity, document and data checks against the DVS and Australian data sources, run from the Portal or by API.

Visit IDFEX ID Checkarrow_forwardcheck_circleIncluded in the Global Data Portal
ID PassSelf-service verification

Customers verify their own identity and biometrics from a link on their phone. The result comes back to you, and they keep control of their data.

Visit ID Passarrow_forwardcheck_circleIncluded in the Global Data Portal
InsiightData quality

Verifies, corrects and enriches customer records so they stay accurate — one at a time or across your whole database.

Visit Insiightarrow_forwardcheck_circleIncluded in the Global Data Portal
Australian Death CheckDeceased data

The official national death data source. Match your records against it to find and remove deceased individuals.

Visit Australian Death Checkarrow_forwardcheck_circleIncluded in the Global Data Portal
QuesterMarketing lists

Build targeted, privacy-compliant Australian marketing lists with smart filters. Pay only for the records you download.

Visit Questerarrow_forwardcheck_circleIncluded in the Global Data Portal
verified_userVerify identities7 solutions

Confirm a person or business is who they claim to be: government IDs, biometrics, business registries and employment checks against authoritative Australian sources.

All solutionsarrow_forwardcheck_circleAvailable in the Portal and by API
policy_alertStay compliant6 solutions

Meet AUSTRAC obligations and understand customer risk: screening, risk assessment, fraud controls and investigation tools with evidence recorded for each check.

All solutionsarrow_forwardcheck_circleAvailable in the Portal and by API
databaseImprove your data3 solutions

Keep customer records accurate and put them to work: correct and enrich existing data, unify it into a single view, or build compliant marketing lists from opted-in records.

All solutionsarrow_forwardcheck_circleAvailable in the Portal and by API
monitoringWatchEye API14 categories

The WatchEye API gives programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, monitoring programs, events and reports.

View allarrow_forwardcheck_circleSandbox environment for integration testing
policyAML & screening6 use cases

Obligations under the AML/CTF Act, from screening at onboarding through to ongoing monitoring — with the evidence for each check recorded.

All use casesarrow_forwardcheck_circleMapped to the products and data that cover it
how_to_regOnboarding & identity3 use cases

Verifying who a customer, employee or account holder is — at sign-up and during ongoing checks — against authoritative Australian sources.

All use casesarrow_forwardcheck_circleMapped to the products and data that cover it
databaseData & enrichment4 use cases

Keeping customer records accurate, current and complete: validate contact detail, fill the gaps, locate people and remove deceased records.

All use casesarrow_forwardcheck_circleMapped to the products and data that cover it
Global Data
Portalarrow_forward
Productsexpand_more
Solutionsexpand_more
Use casesexpand_more
Dataexpand_more
APIarrow_forwardIndustriesarrow_forwardResourcesarrow_forwardAboutarrow_forwardContactarrow_forward Request a Demo
Talk to the team

9am–5pm AEST, Monday to Friday.

call03 9948 4089
ID Pass

Cancel an ID Pass API

Cancel an ID Pass stops a verification that has not yet been completed. Only an ID Pass whose status is new, opened or in progress can be cancelled, and the fee is refunded if no verification step had been taken.

  • Cancels an ID Pass in the new, opened or in_progress state; completed, expired, failed or cancelled passes return an error
  • The response states whether the fee was refunded, so the outcome is on record
For developers

After the technical detail?

For the technical detail, go to the API documentation. It holds the request and response schema, the integration guides and the error codes for this endpoint.

  • Request and response schema
  • Refund behaviour
View developer documentation

Accounts start in the sandbox. Production keys are issued once the account is approved.

Encrypted in transit and at rest Handled under the Australian Privacy Principles
What the check gives you

Stopping a verification you no longer need, and knowing whether you were charged

A customer withdraws, an application is abandoned, or a link was created in error. Cancel an ID Pass ends the verification so the link can no longer be used, and tells you whether the fee came back. Unlike its WatchEye counterpart, the Global Data ID Pass can be cancelled through the API.

Which ID Passes can be cancelled

Those whose status is new, opened or in_progress. An ID Pass that is complete, expired, failed or already cancelled returns an error.

When the fee is refunded

If the status is still new or opened, meaning no verification step has been taken, the fee is refunded.

When it is not

If any step has been taken, for example the status is in_progress or the customer has started the flow, no refund is issued.

What comes back

The ID Pass ID, the status cancelled, and a flag stating whether a fee refund was applied.

How a check runs

Where cancelling fits in the life of an ID Pass

An ID Pass moves from new to opened to in progress to a final state. Cancelling ends it early and is itself a final state; whether the fee returns depends on how far the customer had got.

Only new, opened and in_progress can be cancelled. Cancelled is terminal: the link stops working and the ID Pass cannot be resumed.

What it costs

A monthly subscription, drawn down as you run checks

Your subscription is credited to your account each month and each check consumes credits from it. If you go past the included amount, further checks are charged at a per-check rate. The rate depends on the volume you commit to, so the sales team is the fastest way to find where your business lands.

  • Pay as you go available
  • No lock-in contract
How billing works
Subscribe monthly, spend it as credits
  • The monthly subscription arrives as credits on your account.
  • Each check draws down credits as it runs.
  • Checks beyond the included credits are billed per check.
  • Higher monthly volume moves you to a lower rate.
Talk to sales about volume
Related checks

Others in ID Pass

Create an ID Pass generates the link. Read an ID Pass shows the status before you decide to cancel.

Questions

Questions we get asked about Cancel an ID Pass

Do we need a developer to implement this?
Yes. Cancel an ID Pass is a REST endpoint that takes the ID Pass ID and returns a JSON result, so a developer connects it to the place in your system where an application is withdrawn. A sandbox with a deterministic test dataset is provided at no usage cost, so the integration can be built and tested before production keys are issued.
What does our system need to send?
The ID Pass ID. Nothing else.
What comes back?
The ID Pass ID, the status, which is cancelled, and a fee refunded flag that is true when no verification steps had been taken and a fee had been charged.
What if the customer has already started?
The ID Pass can still be cancelled while its status is in_progress, but no refund is issued because a verification step has been taken.
Can a cancelled ID Pass be reopened?
No. Cancelled is a final status. Create a new ID Pass if the customer still needs to be verified.
Getting started

The first step to access is a conversation

New accounts begin with sandbox access, and production API keys are issued once the account has been commercially approved.

Call 03 9948 4089, 9am–5pm AEST Monday to Friday

Encrypted in transit and at rest
Handled under the Australian Privacy Principles
ISO 27001 Certified