Integrate compliance at the API level
Automate identity verification, liveness checks, and risk screening directly from your backend with our low-latency REST API.
Authorization: Bearer sk_live_...
Content-Type: application/json
{
"status": "verified",
"verification_id": "req_99b4x",
"results": {
"liveness": "passed",
"id_match": true
}
}
API Catalogue
Our advanced RESTful API offers an ideal solution for seamless integration into your software ecosystem. Designed for both real-time and offline access, our API ensures flexibility and reliability. Expertly developed with the same robust queries that power our SaaS platforms, it allows you to effortlessly combine and encapsulate queries to create powerful, customised products and services. By leveraging our API, you can enhance your software’s functionality, streamline operations, and deliver superior user experiences with minimal friction.
Developer documentation
Browse the complete API specifications, authentication guides, and integration pathways for each platform.
Global Data API
The Global Data API allows external programmatic access to the full functionality of the Global Data suite of validation,verification and search functions. The API accesses the same dataset and will produce the same results as the api.globaldata.net.au web system.
Address
7 endpoints
Address
7 endpoints
Address Autocomplete API
Address Auto-Complete is a powerful API query that can save users time and reduce errors by predicting and suggesting Australian addresses as they are being typed.
Address Autocomplete API
Address Auto-Complete is a powerful API query that can save users time and reduce errors by predicting and suggesting Australian addresses as they are being typed.
Address Auto-Complete is a powerful API query that can save users time and reduce errors by predicting and suggesting Australian addresses as they are being typed. This feature can be integrated into any web or mobile application to streamline data entry and improve overall data accuracy.
Address Lookup by Contact API
Returns the GNAF ID which corresponds to a given email address or phone number from the Global Data universe.
Address Lookup by Contact API
Returns the GNAF ID which corresponds to a given email address or phone number from the Global Data universe.
Returns the GNAF ID which corresponds to a given email address or phone number from the Global Data universe.
Address Validate API
Tests a supplied address against the GNAF database and returns a quality score from 0 to 10, plus the matched address with any corrections applied.
Address Validate API
Tests a supplied address against the GNAF database and returns a quality score from 0 to 10, plus the matched address with any corrections applied.
Tests a supplied address against the GNAF database and returns a quality score from 0 to 10, plus the matched address with any corrections applied. The validator will fix minor mistakes (spelling errors in the street or suburb, the wrong street type, a postcode that's one off) so long as the rest of the address is still resolvable. You get the corrected address back along with a list of every change that was made.
Address Validate Bulk API
The bulk version of Address Validate.
Address Validate Bulk API
The bulk version of Address Validate.
The bulk version of Address Validate. Up to 200 addresses in a single call. Each item uses the same validation rules and input modes as the single endpoint. Optional check_id per request for correlating results back to your inputs..
Property Detail API
Provides the resident and contact details (phone and email) linked to an address referenced by a GNAF ID.
Property Detail API
Provides the resident and contact details (phone and email) linked to an address referenced by a GNAF ID.
Provides the resident and contact details (phone and email) linked to an address referenced by a GNAF ID. Automatically performs a connectivity and DNC check.
Real Estate Search (Bulk) API
Bulk version of the real estate search endpoint that allows up to 50 address lookups to be performed in a single request…
Real Estate Search (Bulk) API
Bulk version of the real estate search endpoint that allows up to 50 address lookups to be performed in a single request…
Bulk version of the real estate search endpoint that allows up to 50 address lookups to be performed in a single request.
Real Estate Search API
Returns the real estate listing history (sale, sold, and rental events) for a property, sourced from the GlobalData Australian property universe.
Real Estate Search API
Returns the real estate listing history (sale, sold, and rental events) for a property, sourced from the GlobalData Australian property universe.
Returns the real estate listing history (sale, sold, and rental events) for a property, sourced from the GlobalData Australian property universe. Accepts a GNAF ID, a full address as a single string, or structured address parts. Results come back most recent first, with an optional date_from filter to limit to recent activity
Phone
4 endpoints
Phone
4 endpoints
Check phone connectivity API
Tests the connectivity of one or more supplied phone numbers (Connected, Disconnected, Undetermined, Invalid).
Check phone connectivity API
Tests the connectivity of one or more supplied phone numbers (Connected, Disconnected, Undetermined, Invalid).
Tests the connectivity of one or more supplied phone numbers (Connected, Disconnected, Undetermined, Invalid).
Check phone DNC status API
Tests the DNC (Do Not Call) status of one or more supplied phone numbers against the Australian DNC register.
Check phone DNC status API
Tests the DNC (Do Not Call) status of one or more supplied phone numbers against the Australian DNC register.
Tests the DNC (Do Not Call) status of one or more supplied phone numbers against the Australian DNC register.
Phone Contact Lookup API
Retrieve the person or persons linked to a specific Australian phone number in the Global Data Universe.
Phone Contact Lookup API
Retrieve the person or persons linked to a specific Australian phone number in the Global Data Universe.
Retrieve the person or persons linked to a specific Australian phone number in the Global Data Universe.
Phone Contact Validate API
Validates the link between a specific Australian phone number and a person associated with that phone number.
Phone Contact Validate API
Validates the link between a specific Australian phone number and a person associated with that phone number.
Validates the link between a specific Australian phone number and a person associated with that phone number. Returns match, possible match, or no match.
Email
1 endpoint
Check email deliverability API
Tests the deliverability of one or more supplied email addresses.
Check email deliverability API
Tests the deliverability of one or more supplied email addresses.
Tests the deliverability of one or more supplied email addresses.
Person
5 endpoints
Person
5 endpoints
Banned and Disqualified Person Search API
Screens an individual against multiple public authorities in one call.
Banned and Disqualified Person Search API
Screens an individual against multiple public authorities in one call.
Screens an individual against multiple public authorities in one call. It covers the ASIC Banned Persons Register and the ATO Disqualified SMSF Trustees list. Bulk requests are supported, with a configurable similarity threshold and three search modes (narrow, medium, broad) that change how strictly the names have to line up. Use it for both transactional checks and batch screening of director rosters or trustee lists.
Deceased Check API
Checks whether a person is recorded as deceased in the Global Data death check service.
Deceased Check API
Checks whether a person is recorded as deceased in the Global Data death check service.
Checks whether a person is recorded as deceased in the Global Data death check service. You can search by name and date of birth, by name and date of death, or by all three. The name-matching rules shift depending on which combination you send. The response is a simple Y or N indicator that drops easily into KYC pipelines and customer maintenance flows.
Enhance Record Plus API
Hand it a partial person record and it gives you back the full picture: verified address, additional phones and emails, possible business associations, demographic indices, plus court records and social records for the matched contacts.
Enhance Record Plus API
Hand it a partial person record and it gives you back the full picture: verified address, additional phones and emails, possible business associations, demographic indices, plus court records and social records for the matched contacts.
Hand it a partial person record and it gives you back the full picture: verified address, additional phones and emails, possible business associations, demographic indices, plus court records and social records for the matched contacts. The "Plus" tier runs the court and social checks automatically on the matched result, so you get a richer dossier than the base Enhance Record service in a single call.
Marketing Contact Lookup API
A contact lookup for marketing and outreach work.
Marketing Contact Lookup API
A contact lookup for marketing and outreach work.
A contact lookup for marketing and outreach work. You give it one piece of information about a person (a phone, an email, a GNAF ID, or an address) and it returns up to 25 matching records from the GlobalData universe, ordered most recent first. Every phone and email comes back with its own opt-in flag so you know what you can actually use in a campaign. Deceased and suppressed records are filtered out before you see them.
Person History API
Query and retrieve additional historical data for a specific individual.
Person History API
Query and retrieve additional historical data for a specific individual.
Query and retrieve additional historical data for a specific individual. Includes an automatic Australian Death Check (ADC).
Deceased Check
2 endpoints
Deceased Check
2 endpoints
ADC Check API
Searches an individual against the Australian Death Check (ADC), the official death register data.
ADC Check API
Searches an individual against the Australian Death Check (ADC), the official death register data.
Searches an individual against the Australian Death Check (ADC), the official death register data. You get any matching records back, including the exact date of death where available (or a date range where it's not), the state the death was registered in, and the ADC reference number. Use this when your compliance posture wants verification against the official register rather than a proprietary dataset.
ADC Check Bulk API
The same as our ADC check, but you can submit a batch of lookups in one call.
ADC Check Bulk API
The same as our ADC check, but you can submit a batch of lookups in one call.
The same as our ADC check, but you can submit a batch of lookups in one call. Each request carries a check_id so you can correlate results back to your inputs. Suited to periodic batch hygiene runs across customer registers, super funds, insurance books and other long-tenured populations.
DVS
14 endpoints
DVS
14 endpoints
Validate a birth certificate API
Validates an Australian birth certificate against the DVS.
Validate a birth certificate API
Validates an Australian birth certificate against the DVS.
Validates an Australian birth certificate against the DVS. All eight states and territories are supported. Which identifiers you need (registration number, certificate number, registration date) depends on the state. The certificate number is the most reliable identifier across the board, so use it where you can.
Validate a Centrelink concession card API
Validates a Centrelink-issued concession card against the DVS: Health Care Card (HCC), Pensioner Concession Card (PCC), or Commonwealth Seniors Health Card (SHC).
Validate a Centrelink concession card API
Validates a Centrelink-issued concession card against the DVS: Health Care Card (HCC), Pensioner Concession Card (PCC), or Commonwealth Seniors Health Card (SHC).
Validates a Centrelink-issued concession card against the DVS: Health Care Card (HCC), Pensioner Concession Card (PCC), or Commonwealth Seniors Health Card (SHC). Used for verifying eligibility for concession-based products, services and pricing tiers.
Validate a change of name certificate API
Validates a Change of Name certificate against the DVS.
Validate a change of name certificate API
Validates a Change of Name certificate against the DVS.
Validates a Change of Name certificate against the DVS. Used when a customer has legally changed their name and you need to verify the certificate that establishes the new legal name against the issuing state Registry.
Validate a citizenship certificate API
Validates an Australian citizenship certificate against the DVS using the stock number and acquisition date.
Validate a citizenship certificate API
Validates an Australian citizenship certificate against the DVS using the stock number and acquisition date.
Validates an Australian citizenship certificate against the DVS using the stock number and acquisition date. Confirms the certificate was genuinely issued by the Department of Home Affairs and matches the identity you've supplied.
Validate a death certificate API
Validates an Australian death certificate against the DVS.
Validate a death certificate API
Validates an Australian death certificate against the DVS.
Validates an Australian death certificate against the DVS. Confirms the certificate was genuinely issued by the Registry of Births, Deaths and Marriages in the issuing state and matches the details you've supplied. Used in estate administration, life insurance claims and superannuation death benefits work.
Validate a drivers licence API
Validates an Australian driver licence against the DVS.
Validate a drivers licence API
Validates an Australian driver licence against the DVS.
Validates an Australian driver licence against the DVS. All eight states and territories are supported. The endpoint accepts both the licence number and the card number, which is required by most states for verification. This is by far the most-used DVS document in Australian identity verification workflows.
Validate a marriage certificate API
Validates an Australian marriage certificate against the DVS.
Validate a marriage certificate API
Validates an Australian marriage certificate against the DVS.
Validates an Australian marriage certificate against the DVS. Confirms both parties' names, the event date and registration details against the issuing state's Registry of Births, Deaths and Marriages.
Validate a Medicare card API
Validates an Australian Medicare card against the DVS.
Validate a Medicare card API
Validates an Australian Medicare card against the DVS.
Validates an Australian Medicare card against the DVS. Green, yellow and blue cards are all supported. The Medicare card is one of the most-presented IDs in Australia and a core part of 100-point ID checks. The endpoint accepts the multi-line name format printed on Medicare cards (up to four lines).
Validate a registration by descent certificate API
Validates an Australian Registration by Descent certificate against the DVS.
Validate a registration by descent certificate API
Validates an Australian Registration by Descent certificate against the DVS.
Validates an Australian Registration by Descent certificate against the DVS. Issued to people born outside Australia who are Australian citizens by virtue of being born to an Australian parent. This certificate is their proof-of-citizenship document.
Validate an ASIC/MSIC Card API
Validates an Aviation Security Identification Card (ASIC) or Maritime Security Identification Card (MSIC) against the DVS.
Validate an ASIC/MSIC Card API
Validates an Aviation Security Identification Card (ASIC) or Maritime Security Identification Card (MSIC) against the DVS.
Validates an Aviation Security Identification Card (ASIC) or Maritime Security Identification Card (MSIC) against the DVS. Both are federally regulated cards required for unescorted access to secure airside and maritime zones.
Validate an ImmiCard API
Validates an Australian Department of Home Affairs ImmiCard against the DVS.
Validate an ImmiCard API
Validates an Australian Department of Home Affairs ImmiCard against the DVS.
Validates an Australian Department of Home Affairs ImmiCard against the DVS. ImmiCards are issued to non-citizens to help them establish identity in Australia, particularly refugees, humanitarian entrants and substantive visa holders who don't yet have an Australian-issued ID.
Validate Australian travel documents API
Validates an Australian Passport, Certificate of Identity, Document of Identity or UN Convention Travel Document against the DVS.
Validate Australian travel documents API
Validates an Australian Passport, Certificate of Identity, Document of Identity or UN Convention Travel Document against the DVS.
Validates an Australian Passport, Certificate of Identity, Document of Identity or UN Convention Travel Document against the DVS. The passport check is high-assurance. Pair it with another DVS document and you've covered most of the strongest tiers of identity verification.
Validate Australian visas API
Validates an Australian visa using the holder's foreign passport against the DVS.
Validate Australian visas API
Validates an Australian visa using the holder's foreign passport against the DVS.
Validates an Australian visa using the holder's foreign passport against the DVS. Confirms that the foreign passport holder has a current valid Australian visa attached to that travel document. Used for employment, tenancy and financial services verification of temporary residents.
Validate with the AEC API
Validates a name, date of birth and address against the Australian Electoral Commission roll via the DVS.
Validate with the AEC API
Validates a name, date of birth and address against the Australian Electoral Commission roll via the DVS.
Validates a name, date of birth and address against the Australian Electoral Commission roll via the DVS. The AEC is one of the broadest identity datasets in the country, which makes this a good low-friction identity check for customers who don't want to hand over a document ID.
Caspar
2 endpoints
Caspar
2 endpoints
Caspar Person Autotrace API
Where Caspar Person Search returns matches against your criteria, Autotrace orchestrates dozens or hundreds of internal searches to assemble a ranked list of likely matches.
Caspar Person Autotrace API
Where Caspar Person Search returns matches against your criteria, Autotrace orchestrates dozens or hundreds of internal searches to assemble a ranked list of likely matches.
Where Caspar Person Search returns matches against your criteria, Autotrace orchestrates dozens or hundreds of internal searches to assemble a ranked list of likely matches. Each one is scored by how well it lines up with the identifiers you supplied. Optionally include possible relatives in the results. Suited to collections, investigations and skip-tracing where the goal is "find this person, and tell me how confident you are".
Caspar Person Search API
The most flexible identity search in the Global Data universe.
Caspar Person Search API
The most flexible identity search in the Global Data universe.
The most flexible identity search in the Global Data universe. Caspar accepts any combination of name, address, phone, email, IP address or social profile URL and returns matching person records with their full known contact and address history. Six "smart" options let you widen or narrow the search, including the smart-search mode that treats name and address as one criterion and the other identifiers as independent matchers.
Payroll and Super Check
3 endpoints
Payroll and Super Check
3 endpoints
Payroll and Super Check API
Runs a Payroll Check and a Super Check in a single call, with independent consent flags for each dataset.
Payroll and Super Check API
Runs a Payroll Check and a Super Check in a single call, with independent consent flags for each dataset.
Runs a Payroll Check and a Super Check in a single call, with independent consent flags for each dataset. You get separated super and payroll result objects in the response. Lets your workflow react to a match in either dataset without two round-trips
Payroll Check API
Validates a person's identity against Australian payroll records.
Payroll Check API
Validates a person's identity against Australian payroll records.
Validates a person's identity against Australian payroll records. Each input field comes back as MATCHED or UNMATCHED (name, date of birth, middle name, address, email, phone, employer ABN). Gives you a useful employment-data signal for KYC, particularly for thin-file individuals who don't have a credit history yet.
Super Check API
Validates identity details against Australian superannuation records.
Super Check API
Validates identity details against Australian superannuation records.
Validates identity details against Australian superannuation records. Per-field MATCHED / UNMATCHED responses across name, DOB, middle name, address, email, phone and employer ABN. Gives you an independent identity signal sourced from the super system, which covers nearly every working Australian.
Sanctions
2 endpoints
Sanctions
2 endpoints
PEP / Sanction Bulk Search API
The bulk version of PEP / Sanction Search.
PEP / Sanction Bulk Search API
The bulk version of PEP / Sanction Search.
The bulk version of PEP / Sanction Search. Submit multiple individual, company or vessel screens in one call, sharing the search type, similarity threshold and country filters across all of them. Suited to periodic batch screening of customer registers, supplier lists and counterparty databases.
PEP / Sanction Search API
Screens individuals, companies and vessels against global PEP (Politically Exposed Persons) and sanctions lists.
PEP / Sanction Search API
Screens individuals, companies and vessels against global PEP (Politically Exposed Persons) and sanctions lists.
Screens individuals, companies and vessels against global PEP (Politically Exposed Persons) and sanctions lists. Search modes run from narrow exact-match through to broad partial-match, with configurable similarity thresholds and country-scoped filters. The response gives you matched sources, similarity scores, and optional extended record data for full investigation context.
Global Data Check
1 endpoint
Global Data Check
1 endpoint
Global Data Check API
The most detailed identity-matching endpoint in the platform.
Global Data Check API
The most detailed identity-matching endpoint in the platform.
The most detailed identity-matching endpoint in the platform. You send a person's identity attributes (names, address parts, DOB, up to four phones and four emails) and it returns a per-field outcome map for every input. Supports a graded match ladder (exact / alias / partial / fuzzy), multi-candidate responses, error tolerance, and configurable per-name matching policies. Use it when you need to know not just whether identity matched, but exactly how.
ID Pass
3 endpoints
ID Pass
3 endpoints
Cancel an ID Pass API
Cancels an in-flight ID Pass.
Cancel an ID Pass API
Cancels an in-flight ID Pass.
Cancels an in-flight ID Pass. Only passes in new, opened or in_progress status can be cancelled. Terminal statuses (complete, expired, failed, cancelled) return an error. A fee refund applies if no verification steps had been taken yet (status still new or opened). Cancelling after any verification activity doesn't refund.
Create an ID Pass API
Generates a secure, configurable identity verification link for a customer.
Create an ID Pass API
Generates a secure, configurable identity verification link for a customer.
Generates a secure, configurable identity verification link for a customer. ID Pass supports Australian driver licences, Australian passports, foreign passports with an Australian visa, Centrelink cards and Medicare cards. The flow routes through the DVS, with optional face liveness, biometric document-photo matching, customer-supplied ID photo, webhook event notifications, and configurable image retention. Sensitive fields are encrypted at rest using a per-pass cipher key that's returned once and never logged.
Read an ID Pass API
Retrieves the full result of an ID Pass.
Read an ID Pass API
Retrieves the full result of an ID Pass.
Retrieves the full result of an ID Pass. You get validation outcomes, biometric results, captured document images, OCR data, and the verified identity. Supply the cipher key returned at registration to receive decrypted values, or omit it and decrypt locally. Optional flags let you pull debug logs, document detail and captured images.
Court Check
2 endpoints
Court Check
2 endpoints
Court Check API
Searches Australian court records against an individual or company name and state.
Court Check API
Searches Australian court records against an individual or company name and state.
Searches Australian court records against an individual or company name and state. Supports summary reports (count by type) or detailed reports (full record list), scoped to civil, criminal, or both listings. Used in KYC, EDD, supplier due diligence and litigation pre-screening.
Court Check Multiple API
The bulk version of Court Check.
Court Check Multiple API
The bulk version of Court Check.
The bulk version of Court Check. Up to 20 requests in a single call, sharing report type, listing, pagination and an optional start date across all items. Suited to batch screening of customer rosters, supplier lists or director groups.
Business Intelligence
2 endpoints
Business Intelligence
2 endpoints
Create a Business Intelligence Request API
Experimental
Pulls together a deep-dive intelligence report on the business behind an ABN.
Create a Business Intelligence Request API
ExperimentalPulls together a deep-dive intelligence report on the business behind an ABN.
Pulls together a deep-dive intelligence report on the business behind an ABN. The report combines ABN status and history, ACN data, recent ASIC documents, business names, domains, websites, ANZSIC code, AUSTRAC remitter details and a generated summary. The query takes a few minutes to compile. Queue it with this endpoint, then poll the retrieve endpoint with the returned request_uuid.
Retrieve a Business Intelligence Request API
Experimental
Retrieves the result of a queued Business Intelligence request API .
Retrieve a Business Intelligence Request API
ExperimentalRetrieves the result of a queued Business Intelligence request API .
Retrieves the result of a queued Business Intelligence request API . Returns pending, processing, complete or failed status. When complete, the response contains the full intelligence payload: ABN history, ACN data, recent ASIC documents, business names, domains, websites, ANZSIC code, AUSTRAC remitter details and a generated business summary.
ASIC
8 endpoints
ASIC
8 endpoints
ASIC Banned Persons Search API
Searches the ASIC register of banned persons specifically.
ASIC Banned Persons Search API
Searches the ASIC register of banned persons specifically.
Searches the ASIC register of banned persons specifically. Covers AFS banned/disqualified, banned futures representatives, banned securities representatives, credit banned/disqualified, and disqualified directors. Same search-mode and similarity-threshold logic as the broader Banned and Disqualified Person Search, but scoped to ASIC-sourced data only.
ASIC Extract API
Orders a full ASIC company or person extract.
ASIC Extract API
Orders a full ASIC company or person extract.
Orders a full ASIC company or person extract. Supports current, historical and relational extract types for companies. Current or historical for persons. The job is queued and returns an api_reference. Poll the retrieve endpoint until the extract payload is read
ASIC Extract Company Search API
Finds the ASIC identifiers you need when ordering a company extract via /asic_extract.
ASIC Extract Company Search API
Finds the ASIC identifiers you need when ordering a company extract via /asic_extract.
Finds the ASIC identifiers you need when ordering a company extract via /asic_extract. Supports ABN, ACN and free-form name search modes, auto-detected from the input format. Name searches accept registration status filters (registered / deregistered / all) and optional postcode or state filters to narrow large name-match result sets.
ASIC Extract Person Search API
Finds the ASIC person_id identifiers you need to order a full person extract.
ASIC Extract Person Search API
Finds the ASIC person_id identifiers you need to order a full person extract.
Finds the ASIC person_id identifiers you need to order a full person extract. You send legal name, date of birth and extract type. The response is matched ASIC identities, including any linked person IDs (where someone has the same name and DOB recorded across different shareholdings, for example). Pass those linked IDs through to the extract call so the resulting extract stitches together every related role
ASIC ID Check API
Verifies an individual against the ASIC officeholder and shareholder register using their name and date of birth.
ASIC ID Check API
Verifies an individual against the ASIC officeholder and shareholder register using their name and date of birth.
Verifies an individual against the ASIC officeholder and shareholder register using their name and date of birth. The response is a compact match_results summary telling you whether the details match an ASIC record, without exposing PII. Use it when you need to confirm a person is on the ASIC register without ordering the full extract.
ASIC Search API
Searches the ASIC register for a company or business name.
ASIC Search API
Searches the ASIC register for a company or business name.
Searches the ASIC register for a company or business name. You can look up by number (ABN, ACN, or state business registration number) for a direct hit, or by exact business name. Returns the full ASIC profile: identifier, jurisdiction, name, type, class, subclass, status, ABR entity details, registration dates, addresses, and recent ASIC documents.
ASIC Search Bulk API
The bulk version of ASIC Search.
ASIC Search Bulk API
The bulk version of ASIC Search.
The bulk version of ASIC Search. Submit multiple company or business-name lookups in one call, with an optional check_id for result correlation. Suited to portfolio onboarding, supplier roster checks and periodic register hygiene.
Retrieve ASIC Extract API
Polls the status of an ASIC extract previously queued via POST /asic_extract.
Retrieve ASIC Extract API
Polls the status of an ASIC extract previously queued via POST /asic_extract.
Polls the status of an ASIC extract previously queued via POST /asic_extract. Returns 202 while still processing, 200 with the full JSON payload when complete. Append ?pdf=true to get a formatted PDF copy instead of JSON. Retrieval calls aren't billable, so you can poll until the extract is ready without extra cost.
Company Risk
3 endpoints
Company Risk
3 endpoints
ASIC Company Search (Risk) API
Finds the ASIC identifiers needed to order a Company Risk report.
ASIC Company Search (Risk) API
Finds the ASIC identifiers needed to order a Company Risk report.
Finds the ASIC identifiers needed to order a Company Risk report. Same input modes as the extract company search: ABN, ACN, or free-form name, with optional status, postcode and state filters to narrow large name-match result sets.
Company Risk Report API
Orders a company risk report using an ABN or ACN.
Company Risk Report API
Orders a company risk report using an ABN or ACN.
Orders a company risk report using an ABN or ACN. The job is queued and an api_reference is returned. Poll the retrieve endpoint until the report is complete.
Retrieve Company Risk Report API
Polls the status of a Company Risk report queued via POST /company_risk.
Retrieve Company Risk Report API
Polls the status of a Company Risk report queued via POST /company_risk.
Polls the status of a Company Risk report queued via POST /company_risk. Returns 202 while still compiling, 200 with the full JSON report when complete. Append ?pdf=true for a formatted PDF. Polling isn't billable.
Likeness Check
1 endpoint
Likeness Check
1 endpoint
Likeness (Face Similarity) Check API
Compares two face images and returns a similarity score plus a threshold-based pass or fail.
Likeness (Face Similarity) Check API
Compares two face images and returns a similarity score plus a threshold-based pass or fail.
Compares two face images and returns a similarity score plus a threshold-based pass or fail. Use it to validate whether an ID document portrait (typically from a driver licence) and a live selfie represent the same individual. The configurable similarity threshold lets you tighten or loosen the pass bar to suit your risk appetite.
Liveness Check
2 endpoints
Liveness Check
2 endpoints
Create a Liveness Check API
Creates a hosted liveness verification link.
Create a Liveness Check API
Creates a hosted liveness verification link.
Creates a hosted liveness verification link. The end user is guided through a face liveness capture flow in their browser. The result (live human vs spoof attempt) can then be retrieved via the GET endpoint or pushed to your webhook. Configurable link validity, threshold and audit-image retention give you control over the flow without writing your own capture UI.
Retrieve a Liveness Check Result API
Retrieves the status or final result of a liveness check using the token returned from the create endpoint.
Retrieve a Liveness Check Result API
Retrieves the status or final result of a liveness check using the token returned from the create endpoint.
Retrieves the status or final result of a liveness check using the token returned from the create endpoint. Idempotent and safe to poll. Returns 202 while the check is pending or in progress, 200 when complete (with result object), and 410 if the link expired without completion.
ID Document
1 endpoint
ID Document
1 endpoint
Extract ID Document Data & Face Image API
Performs OCR and data extraction on an Australian identity document (passport, driver licence, or Medicare card) and returns parsed identity fields plus a cropped face portrait where available.
Extract ID Document Data & Face Image API
Performs OCR and data extraction on an Australian identity document (passport, driver licence, or Medicare card) and returns parsed identity fields plus a cropped face portrait where available.
Performs OCR and data extraction on an Australian identity document (passport, driver licence, or Medicare card) and returns parsed identity fields plus a cropped face portrait where available. Use it when you're embedding into a custom KYC or onboarding flow and need extracted identity data without committing to the full ID Pass hosted flow.
Adverse Media
1 endpoint
Adverse Media
1 endpoint
Adverse Media Check API
Experimental
Searches for adverse media coverage of a person or business.
Adverse Media Check API
ExperimentalSearches for adverse media coverage of a person or business.
Searches for adverse media coverage of a person or business. Returns a generated summary, citation links to the source articles, and category tags spanning financial crime, violent crime, organised crime, drug offences, sexual offences, regulatory action, terrorism, scams and fraud, environmental violations, employment violations, and corruption and abuse of office. Built to inform enhanced due diligence on high-risk customers and counterparties.
UK Companies House
9 endpoints
UK Companies House
9 endpoints
Company House Officer Search API
Searches UK Companies House for officers (directors, secretaries and other officials).
Company House Officer Search API
Searches UK Companies House for officers (directors, secretaries and other officials).
Searches UK Companies House for officers (directors, secretaries and other officials). Fuzzy name match across all UK companies, with an optional date-of-birth filter (year and month only — Companies House doesn't publish the day). Returns matching officer IDs, addresses, appointment counts and role summaries.
Company House Search API
Searches the UK Companies House register for a company by name or company number.
Company House Search API
Searches the UK Companies House register for a company by name or company number.
Searches the UK Companies House register for a company by name or company number. The endpoint auto-detects whether the input is a company number (for example 12345678, SC123456, NI012345, FC012345, OC123456) or a free-form name, then dispatches the right search. Returns the company number, registered name, status, type, incorporation date and registered office address.
Create Company House Officer Report API
Orders a UK officer report.
Create Company House Officer Report API
Orders a UK officer report.
Orders a UK officer report. Covers personal details, current and former appointments, and disqualification records (when disqualified: true). Async queue and retrieve pattern. The returned api_reference is used to poll the retrieve endpoint.
Create UK Company Report API
Orders a UK Companies House company report.
Create UK Company Report API
Orders a UK Companies House company report.
Orders a UK Companies House company report. The report covers registration details, registered office, current and previous names, officers (directors and secretaries), persons with significant control, filing history summary, accounts information and any charges. The job is queued and async. Poll the retrieve endpoint with the returned api_reference.
Retrieve Company House Report API
Polls the status of a UK Companies House company report queued via POST /company_house_report.
Retrieve Company House Report API
Polls the status of a UK Companies House company report queued via POST /company_house_report.
Polls the status of a UK Companies House company report queued via POST /company_house_report. Returns 202 while compiling, 200 when ready with the full JSON payload. Append ?pdf=true for a formatted PDF copy. Retrieval calls aren't billable.
Retrieve UK Officer Report API
Polls the status of a UK officer report queued via POST /company_house_officer_report.
Retrieve UK Officer Report API
Polls the status of a UK officer report queued via POST /company_house_officer_report.
Polls the status of a UK officer report queued via POST /company_house_officer_report. Returns 202 while compiling, 200 when ready with the full JSON payload: appointments, personal details and disqualifications. Append ?pdf=true for a PDF copy. Retrieval calls aren't billable.
UK Business Check API
Performs a synchronous check of a single UK company by its Companies House company number.
UK Business Check API
Performs a synchronous check of a single UK company by its Companies House company number.
Performs a synchronous check of a single UK company by its Companies House company number. This is the UK equivalent of the Australian /business_check endpoint: one request, one JSON reply, no polling. The response combines the Companies House company profile, the full list of current and resigned officers, and the most recent filing history into a single flat match object.
UK Business Check API (Bulk)
The UK Business Check API checks up to 50 UK companies in a single synchronous request.
UK Business Check API (Bulk)
The UK Business Check API checks up to 50 UK companies in a single synchronous request.
The UK Business Check API checks up to 50 UK companies in a single synchronous request. Each item in requests is looked up exactly as /uk_business_check would, and the results are returned in the same order with the caller's check_id echoed back for correlation.
UK Company House Document API
Retrieves a specific UK Companies House document by its document ID.
UK Company House Document API
Retrieves a specific UK Companies House document by its document ID.
Retrieves a specific UK Companies House document by its document ID. The document ID is usually pulled from a company report's filing history. Documents come back as PDF and cover annual accounts, confirmation statements, articles of association, certificates of incorporation, change of director notifications and similar filings.
NZ Identity Verification
1 endpoint
Verifies an individual's identity against the New Zealand NZTA Driver Licence database.
NZ Identity Verification
1 endpointVerifies an individual's identity against the New Zealand NZTA Driver Licence database.
NZ Driver Licence Check API
The NZ Driver Licence Check API endpoint validates a New Zealand driver licence against the NZTA database.
NZ Driver Licence Check API
The NZ Driver Licence Check API endpoint validates a New Zealand driver licence against the NZTA database.
The NZ Driver Licence Check API endpoint validates a New Zealand driver licence against the NZTA database. It requires both the licence number and the version number. The driver licence is the primary document used in identity verification workflows.
WatchEye API
Programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, ongoing monitoring programmes, and reports.
WatchEye
14 categories · 60 endpoints
The WatchEye API gives programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, monitoring programs, events and reports.
WatchEye
14 categories · 60 endpointsThe WatchEye API gives programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, monitoring programs, events and reports.
Account
1 endpoint
Account
1 endpoint
Show the calling account
Returns the account that this API key belongs to, including the environment, the products
the account can use, and the …
Show the calling account
Returns the account that this API key belongs to, including the environment, the products the account can use, and the …
Returns the account that this API key belongs to, including the environment, the products the account can use, and the current billing balance. This is the recommended first call for any new integration: it lets you confirm that your credentials work, that you are pointed at the expected environment (live or sandbox), and that the products you intend to use are enabled on the account.
Users
3 endpoints
Users
3 endpoints
List users
List all users on the account.
List users
List all users on the account.
List all users on the account.
Show user
Return a single user by UUID.
Show user
Return a single user by UUID.
Return a single user by UUID.
Update user
Update a single user by UUID.
Update user
Update a single user by UUID.
Update a single user by UUID. The update user record is returned in the response.
Programs
5 endpoints
Programs
5 endpoints
Create a program
Create a new program in the calling account.
Create a program
Create a new program in the calling account.
Create a new program in the calling account. Only program_name is required; every other field has a sensible default.
Delete a program
Soft-deletes the program and every entity in it (and that entity's checks, ID checks,
reports, events, notes and crossm…
Delete a program
Soft-deletes the program and every entity in it (and that entity's checks, ID checks, reports, events, notes and crossm…
Soft-deletes the program and every entity in it (and that entity's checks, ID checks, reports, events, notes and crossmatches). The records are no longer returned by list/show endpoints but remain in the database for compliance and audit purposes. The deleted program record is returned in the response as confirmation; a subsequent show or list call for it will return 404.
List programs
Returns the programs belonging to the calling account.
List programs
Returns the programs belonging to the calling account.
Returns the programs belonging to the calling account. Soft-deleted programs are excluded. Results are paginated.
Show a program
Returns a single program by its UUID.
Show a program
Returns a single program by its UUID.
Returns a single program by its UUID. Unknown UUIDs return 404.
Update a program
Update an existing program using PATCH semantics: only the fields you supply are changed,
everything else is left as-is…
Update a program
Update an existing program using PATCH semantics: only the fields you supply are changed, everything else is left as-is…
Update an existing program using PATCH semantics: only the fields you supply are changed, everything else is left as-is. Pass null to clear an optional field. Note: when changing event_grouping to separate you must also supply max_separate_events. Conversely, when changing it to grouped, any supplied max_separate_events is ignored and the stored value is cleared.
Entities
7 endpoints
Entities
7 endpoints
Archive an entity
Archives the entity together with all checks, reports, events, notes and identification
checks belonging to it. Archive…
Archive an entity
Archives the entity together with all checks, reports, events, notes and identification checks belonging to it. Archive…
Archives the entity together with all checks, reports, events, notes and identification checks belonging to it. Archived records remain fully visible via list and show endpoints and can be included or excluded with the archived query parameter on the entities list.
Create an entity in a program
Create a new entity in the specified program.
Create an entity in a program
Create a new entity in the specified program.
Create a new entity in the specified program. The supplied fields must be appropriate for the chosen entity_type: * individual - requires at least one of first_name / last_name. May supply birth_date. Business, vessel and property fields are ignored. * business - requires business_name. Optionally business_number + business_number_type. Individual, vessel and property fields are ignored.
Delete an entity
Soft-deletes the entity and its dependent records (checks, ID checks, reports, events,
notes and crossmatches). See the…
Delete an entity
Soft-deletes the entity and its dependent records (checks, ID checks, reports, events, notes and crossmatches). See the…
Soft-deletes the entity and its dependent records (checks, ID checks, reports, events, notes and crossmatches). See the Soft Deletion section of the API guide for the full policy (30-day recovery window, portal-only restore, what gets cascaded).
List entities in a program
Returns the entities in the specified program.
List entities in a program
Returns the entities in the specified program.
Returns the entities in the specified program. Results are paginated.
Show an entity
Returns a single entity by its UUID.
Show an entity
Returns a single entity by its UUID.
Returns a single entity by its UUID. Unknown UUIDs return 404.
Unarchive an entity
Restores an archived entity together with all of its checks, reports, events, notes and
identification checks. The enti…
Unarchive an entity
Restores an archived entity together with all of its checks, reports, events, notes and identification checks. The enti…
Restores an archived entity together with all of its checks, reports, events, notes and identification checks. The entity returns to the active set and resumes appearing in monitor runs and default reports. Calling unarchive on an entity that is not currently archived returns the entity in its current state without recording a new audit entry or re-cascading to the child records.
Update an entity
Update an existing entity using PATCH semantics: only the fields you supply are changed,
everything else is left as-is.…
Update an entity
Update an existing entity using PATCH semantics: only the fields you supply are changed, everything else is left as-is.…
Update an existing entity using PATCH semantics: only the fields you supply are changed, everything else is left as-is. Pass null to clear an optional field. Notes: * entity_type cannot be changed after creation. It is silently ignored if supplied. * birth_date is silently ignored if the entity is locked because it has been used in an identification check.
Relationships
4 endpoints
Relationships
4 endpoints
Create a relationship on an entity
Create a relationship FROM the entity in the path TO another entity on your account.
Create a relationship on an entity
Create a relationship FROM the entity in the path TO another entity on your account.
Create a relationship FROM the entity in the path TO another entity on your account. The two entities can belong to different programs. Direction is set by the order: the path entity becomes from_entity_uuid and the to_entity_uuid in the body becomes the to side. To record the relationship the other way around, send the request to the other entity instead.
Delete a relationship
Soft-delete a relationship by its UUID.
Delete a relationship
Soft-delete a relationship by its UUID.
Soft-delete a relationship by its UUID. The record is hidden from the API (it is no longer returned by the list endpoint) but remains in the database during a recovery window. The deleted relationship is returned in the response as confirmation.
List an entity’s relationships
Returns the relationships involving the specified entity, where the entity is either the
from or the to side of the lin…
List an entity’s relationships
Returns the relationships involving the specified entity, where the entity is either the from or the to side of the lin…
Returns the relationships involving the specified entity, where the entity is either the from or the to side of the link. The related entity can be in any program on your account. Results are paginated. Each relationship is returned once with both forward_label and inverse_label, so you can present it from either entity's point of view. See the Relationship schema for the full shape.
Resolve an entity’s ultimate beneficial owners
Resolves the ultimate beneficial owners (UBOs) of a business entity by tracing its
shareholding relationships (the rela…
Resolve an entity’s ultimate beneficial owners
Resolves the ultimate beneficial owners (UBOs) of a business entity by tracing its shareholding relationships (the rela…
Resolves the ultimate beneficial owners (UBOs) of a business entity by tracing its shareholding relationships (the relationship types that carry an ownership percentage) out to the natural persons behind it. Indirect ownership through other companies is followed and each person's stake is aggregated across every chain before the threshold is applied.
Monitors
6 endpoints
Monitors
6 endpoints
Create a monitor
Create a new monitor in the given program.
Create a monitor
Create a new monitor in the given program.
Create a new monitor in the given program. The monitor_check_type is fixed at creation - to change a monitor's operation type, delete it and create a new one.
Delete a monitor
Soft-deletes the monitor.
Delete a monitor
Soft-deletes the monitor.
Soft-deletes the monitor. The deleted monitor is returned in the response as confirmation; subsequent show/list calls for it will return 404. See the Soft Deletion section of the API guide for the full policy (30-day recovery window, portal-only restore).
List monitors in a program
Returns the monitors that belong to the given program.
List monitors in a program
Returns the monitors that belong to the given program.
Returns the monitors that belong to the given program. Soft-deleted monitors are excluded. Results are paginated.
Run a monitor on demand
Queues an immediate run of the monitor and returns 202 Accepted once the run has been
scheduled. The actual screening h…
Run a monitor on demand
Queues an immediate run of the monitor and returns 202 Accepted once the run has been scheduled. The actual screening h…
Queues an immediate run of the monitor and returns 202 Accepted once the run has been scheduled. The actual screening happens in the background - poll GET /monitors/{monitor_uuid} and wait for process_status to transition out of pending / processing before reading the results.
Show a monitor
Returns a single monitor by its UUID.
Show a monitor
Returns a single monitor by its UUID.
Returns a single monitor by its UUID. Unknown UUIDs return 404.
Update a monitor
Update an existing monitor using PATCH semantics: only the fields you supply are
changed; everything else is left as-is…
Update a monitor
Update an existing monitor using PATCH semantics: only the fields you supply are changed; everything else is left as-is…
Update an existing monitor using PATCH semantics: only the fields you supply are changed; everything else is left as-is.
Checks
4 endpoints
Checks
4 endpoints
Download a check as PDF
Returns a printable PDF report for the check, suitable for inclusion in customer-facing
files. The PDF mirrors the on-s…
Download a check as PDF
Returns a printable PDF report for the check, suitable for inclusion in customer-facing files. The PDF mirrors the on-s…
Returns a printable PDF report for the check, suitable for inclusion in customer-facing files. The PDF mirrors the on-screen check report in the portal: subject snapshot, configuration in force, per-match details and a results summary. The response is application/pdf with a Content-Disposition header naming the file after the check's check_number (e.g. check-C-A1B2CD.pdf).
Launch screening checks against an entity
Queues one or more screening checks against a saved entity and returns
202 Accepted with the parent (or single child) c…
Launch screening checks against an entity
Queues one or more screening checks against a saved entity and returns 202 Accepted with the parent (or single child) c…
Queues one or more screening checks against a saved entity and returns 202 Accepted with the parent (or single child) check UUID. The screening runs in the background - poll GET /v1/checks/{uuid} and wait for status to be complete or failed before reading the results. Each requested check type is charged at launch time.
List checks
Returns checks for the calling account.
List checks
Returns checks for the calling account.
Returns checks for the calling account. Results are paginated. Each check represents a single screening run against an entity - for example a PEP and Sanction screen, an email verification, a court records search.
Show a check
Returns a single check by its UUID, including:
* The base envelope (program, entity, outcome, timestamps, etc.) - same …
Show a check
Returns a single check by its UUID, including: * The base envelope (program, entity, outcome, timestamps, etc.) - same …
Returns a single check by its UUID, including: * The base envelope (program, entity, outcome, timestamps, etc.) - same shape as the list endpoint * results_overview[] - one row per result, with a uniform {title, status, alert_ids} shape across all operation types * children[] - per-child summaries when the check is a group; empty otherwise * details - the typed per-operation details block.
Events
3 endpoints
Events
3 endpoints
List events
Returns events for the calling account.
List events
Returns events for the calling account.
Returns events for the calling account. Results are paginated. Each event represents a "thing your team should look at" produced by a screening check - typically a positive PEP/sanction match, a phone or email match, an adverse media hit, etc. Events have lifecycle status (new -> investigating -> closed_*) that you can transition via the PATCH event endpoint.
Show an event
Returns a single event by its UUID, including the full notes collection.
Show an event
Returns a single event by its UUID, including the full notes collection.
Returns a single event by its UUID, including the full notes collection.
Update an event
Update an event's status and/or attach a note.
Update an event
Update an event's status and/or attach a note.
Update an event's status and/or attach a note. At least one of status or note must be supplied; sending neither returns 400 No updates to apply.
Notes
5 endpoints
Notes
5 endpoints
Create a note on an entity
Create a new note attached to the specified entity.
Create a note on an entity
Create a new note attached to the specified entity.
Create a new note attached to the specified entity. The note inherits the entity's program and account. Notes created via this endpoint are attributed to the calling API key (the response created_by carries { type: "api_key", uuid, label }). They cannot be edited or deleted from the portal. Any API key on the same account can manage these notes via the PATCH and DELETE endpoints.
Delete a note
Soft-delete a note.
Delete a note
Soft-delete a note.
Soft-delete a note. The note remains in the database for audit / compliance purposes but is removed from list / show responses (a subsequent show or list call returns 404). See the Soft Deletion section of the API guide for the full policy (30-day recovery window, portal-only restore).
List notes
Returns notes for the calling account.
List notes
Returns notes for the calling account.
Returns notes for the calling account. Results are paginated. Notes are always attached to an entity (and the entity's program). Notes created in the context of an event additionally carry an event_uuid. Use the filters to narrow to a specific entity, program, event, or to a specific author or author type.
Show a note
Returns a single note by its UUID.
Show a note
Returns a single note by its UUID.
Returns a single note by its UUID.
Update a note
Update a note's text.
Update a note
Update a note's text.
Update a note's text. Only note_text can be changed - the note's parent entity, parent event, author and archive state are all immutable from the API. To "move" a note to a different entity or event, delete it and re-create.
ID Checks
4 endpoints
ID Checks
4 endpoints
Download an ID check certificate as PDF
Returns a verification certificate PDF for a completed entity-bound ID check.
Download an ID check certificate as PDF
Returns a verification certificate PDF for a completed entity-bound ID check.
Returns a verification certificate PDF for a completed entity-bound ID check. This endpoint does not bill - PDF generation reuses the existing on-record check data.
Launch an ID check against an entity
Runs a synchronous identification check against a saved entity and returns **200 OK**
with the full completed check pay…
Launch an ID check against an entity
Runs a synchronous identification check against a saved entity and returns **200 OK** with the full completed check pay…
Runs a synchronous identification check against a saved entity and returns **200 OK** with the full completed check payload inline. Unlike screening checks, ID checks do not queue for background processing and do not expose a status field. Each launch is charged at run time after a successful upstream verification call.
List ID checks
Returns entity-bound identification checks for the calling account.
List ID checks
Returns entity-bound identification checks for the calling account.
Returns entity-bound identification checks for the calling account. Results are paginated. Each record represents a synchronous document verification run against a saved entity (DVS or non-DVS). The list endpoint returns a compact envelope; use show ID check to read consent, verification details and the typed details block. ID checks run synchronously - there is no status field.
Show an ID check
Returns a single entity-bound ID check by UUID, including consent, verification details
and the typed details block. Do…
Show an ID check
Returns a single entity-bound ID check by UUID, including consent, verification details and the typed details block. Do…
Returns a single entity-bound ID check by UUID, including consent, verification details and the typed details block. Document numbers and other sensitive input fields are never returned - see the ID check field reference for per-type input shapes.
IDPass
6 endpoints
IDPass
6 endpoints
Download an IDPass certificate as PDF
Returns the verification certificate PDF for a completed IDPass.
Download an IDPass certificate as PDF
Returns the verification certificate PDF for a completed IDPass.
Returns the verification certificate PDF for a completed IDPass. This endpoint does not bill - the certificate is generated from the on-record IDPass data.
Download an IDPass image
Returns a single IDPass image as its raw bytes, mirroring the
download IDPass PDF endpoint. The Content-Type is the ima…
Download an IDPass image
Returns a single IDPass image as its raw bytes, mirroring the download IDPass PDF endpoint. The Content-Type is the ima…
Returns a single IDPass image as its raw bytes, mirroring the download IDPass PDF endpoint. The Content-Type is the image's stored MIME type (typically image/jpeg) and a Content-Disposition header suggests an inline filename. The image_type is one of the file types listed in the images array of the show IDPass response (e.g.
Launch an adhoc IDPass
Creates a remote identity verification (IDPass) that is not tied to a saved entity and
returns **202 Accepted** with th…
Launch an adhoc IDPass
Creates a remote identity verification (IDPass) that is not tied to a saved entity and returns **202 Accepted** with th…
Creates a remote identity verification (IDPass) that is not tied to a saved entity and returns **202 Accepted** with the IDPass shell, including its hosted idpass_link. Use this for one-off verifications where you do not need to persist the individual as an entity.
Launch an IDPass against an entity
Creates a remote identity verification (IDPass) for a saved individual entity and returns
**202 Accepted** with the IDP…
Launch an IDPass against an entity
Creates a remote identity verification (IDPass) for a saved individual entity and returns **202 Accepted** with the IDP…
Creates a remote identity verification (IDPass) for a saved individual entity and returns **202 Accepted** with the IDPass shell, including its hosted idpass_link. The entity must be an individual.
List IDPasses
Returns a paginated list of IDPasses on the calling account.
List IDPasses
Returns a paginated list of IDPasses on the calling account.
Returns a paginated list of IDPasses on the calling account. Each IDPass is a remote identity verification that the individual completes via a hosted link; the result is updated asynchronously, so poll show IDPass until status is terminal.
Show an IDPass
Returns a single IDPass by UUID with its full configuration, current status, verification
outcome, document/validation …
Show an IDPass
Returns a single IDPass by UUID with its full configuration, current status, verification outcome, document/validation …
Returns a single IDPass by UUID with its full configuration, current status, verification outcome, document/validation summaries, activity log, available image metadata and a link back to the originating ID check.
Adhoc ID Checks
5 endpoints
Adhoc ID Checks
5 endpoints
Delete an adhoc ID check
Soft-deletes an adhoc check; the child checks of a group check are deleted with it.
Delete an adhoc ID check
Soft-deletes an adhoc check; the child checks of a group check are deleted with it.
Soft-deletes an adhoc check; the child checks of a group check are deleted with it. WatchEye API reference, with an example request, response and error codes.
Download an adhoc ID check certificate as PDF
Returns a verification certificate PDF for a completed adhoc ID check.
Download an adhoc ID check certificate as PDF
Returns a verification certificate PDF for a completed adhoc ID check.
Returns a verification certificate PDF for a completed adhoc ID check.
Launch an adhoc ID check
Runs a synchronous quick ID check and returns **200 OK** with the full completed payload.
Launch an adhoc ID check
Runs a synchronous quick ID check and returns **200 OK** with the full completed payload.
Runs a synchronous quick ID check and returns **200 OK** with the full completed payload. See launch entity ID check for consent, idempotency and billing behaviour.
List adhoc ID checks
Returns quick (adhoc) identification checks for the calling account.
List adhoc ID checks
Returns quick (adhoc) identification checks for the calling account.
Returns quick (adhoc) identification checks for the calling account. These are one-off checks not tied to a program or entity record. Actor attribution is via the created_by discriminator (user for a portal launch or api_key for an API launch). Filter by created_by, created_by_user_uuid or created_by_api_key_uuid to narrow results.
Show an adhoc ID check
Returns a single adhoc ID check by UUID, including consent, verification details and the
typed details block.
Show an adhoc ID check
Returns a single adhoc ID check by UUID, including consent, verification details and the typed details block.
Returns a single adhoc ID check by UUID, including consent, verification details and the typed details block.
Adhoc Checks
5 endpoints
Adhoc Checks
5 endpoints
Delete an adhoc check
Soft-deletes the adhoc check.
Delete an adhoc check
Soft-deletes the adhoc check.
Soft-deletes the adhoc check. For a group check (check_type = group), its child checks are deleted alongside it. See the Soft Deletion section of the API guide for the full policy (30-day recovery window, portal-only restore). The records are no longer returned by list/show endpoints but remain in the database for compliance and audit purposes.
Download an adhoc check as PDF
Returns a printable PDF report for the adhoc check, suitable for inclusion in
customer-facing files. The PDF mirrors the…
Download an adhoc check as PDF
Returns a printable PDF report for the adhoc check, suitable for inclusion in customer-facing files. The PDF mirrors the…
Returns a printable PDF report for the adhoc check, suitable for inclusion in customer-facing files. The PDF mirrors the on-screen quick-check report in the portal: subject snapshot, configuration in force, per-match details and a results summary. The response is application/pdf with a Content-Disposition header naming the file after the check's check_number (e.g. adhoc-check-Q-A1B2CD.pdf).
Launch adhoc screening checks
Queues one or more "quick check" screening operations against a freeform
subject supplied in the request body and return…
Launch adhoc screening checks
Queues one or more "quick check" screening operations against a freeform subject supplied in the request body and return…
Queues one or more "quick check" screening operations against a freeform subject supplied in the request body and returns 202 Accepted with the parent (or single child) adhoc-check UUID. The screening runs in the background - poll GET /v1/adhoc-checks/{uuid} and wait for status to be complete or failed before reading the results. Each requested check type is charged at launch time.
List adhoc checks
Returns adhoc ("quick") checks for the calling account.
List adhoc checks
Returns adhoc ("quick") checks for the calling account.
Returns adhoc ("quick") checks for the calling account. Results are paginated. An adhoc check is a one-off screening run performed from the portal by an account user against a free-form subject - they do not belong to a program or entity record.
Show an adhoc check
Returns a single adhoc check by its UUID, including:
* The base envelope (created_by, outcome, timestamps, etc.) - same …
Show an adhoc check
Returns a single adhoc check by its UUID, including: * The base envelope (created_by, outcome, timestamps, etc.) - same …
Returns a single adhoc check by its UUID, including: * The base envelope (created_by, outcome, timestamps, etc.) - same shape as the list endpoint * results_overview[] - one row per result, with a uniform {title, status, alert_ids} shape across all operation types * children[] - per-child summaries when the check is a group; empty otherwise * details - the typed per-operation details block.
Audits
2 endpoints
Audits
2 endpoints
List audit entries
Returns audit log entries for the calling account.
List audit entries
Returns audit log entries for the calling account.
Returns audit log entries for the calling account. Results are paginated. The audit log records significant activity on your account: who did what, when, from which IP, and against which resource. Use it to feed external SIEM / compliance systems, to reconstruct an entity's history, or to surface activity in your own UI.
Show an audit entry
Returns a single audit entry by its UUID, including the full properties object for the
action.
The shape of the proper…
Show an audit entry
Returns a single audit entry by its UUID, including the full properties object for the action. The shape of the proper…
Returns a single audit entry by its UUID, including the full properties object for the action. The shape of the properties object varies by action. Treat it as an action-specific bag of contextual data rather than a fixed schema; new keys may be added over time as new features are added.
Want to Build with Our APIs?
Contact our sales team to discuss Sandbox integration requirements and credentials.
Common Questions About Our API
Our RESTful API is designed to make integration into your software effortless and seamless.
rocket_launch
Implementation
What are the benefits of using an API for my business?
add
What are the benefits of using an API for my business?
The benefits of using an API for your business can include streamlining operations, automating processes and gaining access to new data sources.
rocket_launch
Implementation
How does an API integrate with my current systems and processes?
add
How does an API integrate with my current systems and processes?
Our API can be easily integrated with your current systems and processes through simple API calls and webhooks.
rocket_launch
Implementation
What kind of data can I access through the API?
add
What kind of data can I access through the API?
Our API allows you to access a wide range of data, including consumer information, market insights and demographics
shield_lock
Security
How does your API handle security and data privacy?
add
How does your API handle security and data privacy?
Our API uses industry-standard security protocols to ensure that your data is kept safe and secure.
rocket_launch
Implementation
Can you provide examples of businesses similar to mine that have successfully integrated your API?
add
Can you provide examples of businesses similar to mine that have successfully integrated your API?
Yes, we have a diverse range of clients across various industries that have successfully integrated our API into their business operations.
rocket_launch
Implementation
Are there any limitations or usage restrictions on the API?
add
Are there any limitations or usage restrictions on the API?
There may be certain usage restrictions and limitations based on your specific plan or subscription. We recommend reviewing the API documentation or speaking with our team for more information.
Who We Work With
Tailored solutions for highly regulated industries.
Trusted & Compliant Data Solutions
We recognise the vital need for reliable, privacy-compliant data in today’s landscape. Our solutions provide you access to billions of data points, drawing from a wide range of trusted sources, including AML-CTF data, credit bureau data, superannuation and payroll data, government authoritative data, high-net asset data, as well as insurance and treasury data. Our data ensures that clients receive the most accurate, reliable, and trustworthy information available
- check_circle Direct-to-source verifications
- check_circle Real-time dynamic updates
- check_circle Continuous quality assurance
50 M+
Phone & Email Records
40 M+
Adverse Court records
980 M+
Social Media & Employment Records
18 M+
Real Estate Records
7 M+
Deceased Records
2 BN+
Australian Universe Record
Our Products
A comprehensive suite of verification and data enrichment tools engineered to protect your platform.
WatchEye
WatchEye brings everything together, including real-time KYC/KYB alerts, ongoing monitoring, plus identity, document, and biometric verification. It is an all-in-one customer onboarding system.
IDFEX ID Check
IDFEX provides fast, one-to-one Australian identity, document, and data verification checks, in an easy-to-use SaaS platform. Instantly verify government IDs online.
ID Pass
ID Pass lets customers verify their identity and biometrics on their smartphone easily while keeping full control of their data. Generate and send your customers a link to verify themselves.
Australian Death Check
The Australian Death Check is Australia’s only official national death data source. Our platform provides accurate, compliant, and instant access to millions of death records.
Caspar KYC
CASPAR is Australia’s top data tool for finding, verifying, and identifying consumers. It uncovers hidden KYC data with rich background and contact details on your customers.
API
Our RESTful API connects smoothly with all software environments, providing tailored, pre-configured, and ready-to-use queries within our SaaS systems. Built to address data issues and drive automation.
Insiight Enrichment
Insiight improves customer data quality by verifying, correcting, and enriching records so they remain accurate and useful. Instantly append fresh information across your database.
Quester Marketing
Quester makes it easy to build targeted Australian marketing lists. Use smart filters to create privacy-compliant campaigns that match your audience. Only pay for the data that you download
Ready to see our API in action?
SOME OF OUR TRUSTED CLIENTS
Request a Demo
"*" indicates required fields
