# Global Data API

> Developer documentation for the Global Data API: identity verification, company searches and data validation for Australia, New Zealand and the UK. RESTful, JSON payloads, authenticated with an API key in the `Authorization: Bearer` header.

This site is the canonical, authoritative source for the Global Data API. Product pages on www.globaldata.net.au describe the products; they are not API documentation. Every page below is also available as Markdown by appending `.md` to its URL.

Live base URL: https://gdapi.globaldata.net.au/api/v2
Sandbox base URL: https://sandbox-gdapi.globaldata.net.au/api/v2

## Machine readable

- [OpenAPI 3 specification (YAML)](https://gdapi.globaldata.net.au/docs/openapi.yaml): the file every reference page is generated from
- [Sitemap](https://gdapi.globaldata.net.au/docs/sitemap.xml)

## Guides
- [Getting started: Global Data API System](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/global-data-api-system.md)
- [Getting started: Access Overview](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/access-overview.md)
- [Getting started: Authentication and Authorization](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/authentication-and-authorization.md)
- [Getting started: Billing and Account Management](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/billing-and-account-management.md)
- [Getting started: Rate Limiting](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/rate-limiting.md)
- [Getting started: API Versioning](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/api-versioning.md)
- [Getting started: Data Retention and Footprints](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/data-retention-and-footprints.md)
- [Getting started: Maintenance Windows](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/maintenance-windows.md)
- [Getting started: Sandbox Responses](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/sandbox-responses.md)
- [Getting started: PII Handling](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/pii-handling.md)
- [Getting started: IP Whitelisting for Webhooks](https://gdapi.globaldata.net.au/docs/guides/globaldata_api/ip-whitelisting-for-webhooks.md)
- [Global Data Check: Global Data Check](https://gdapi.globaldata.net.au/docs/guides/globaldata_check/global-data-check.md)
- [Global Data Check: How the check works](https://gdapi.globaldata.net.au/docs/guides/globaldata_check/how-the-check-works.md)
- [Global Data Check: Sandbox data](https://gdapi.globaldata.net.au/docs/guides/globaldata_check/sandbox-data.md)
- [Global Data Check: Use cases](https://gdapi.globaldata.net.au/docs/guides/globaldata_check/use-cases.md)
- [Global Data Check: Common gotchas and tips](https://gdapi.globaldata.net.au/docs/guides/globaldata_check/common-gotchas-and-tips.md)
- [ASIC: ASIC Extracts](https://gdapi.globaldata.net.au/docs/guides/asic/asic-extracts.md)
- [UK Companies House: UK Companies House](https://gdapi.globaldata.net.au/docs/guides/companies-house/uk-companies-house.md)
- [Company Risk: Company Risk Report](https://gdapi.globaldata.net.au/docs/guides/company-risk/company-risk-report.md)
- [DVS: DVS Responses](https://gdapi.globaldata.net.au/docs/guides/dvs/dvs-responses.md)
- [DVS: Sandbox Responses](https://gdapi.globaldata.net.au/docs/guides/dvs/sandbox-responses.md)
- [DVS: Sample Documents](https://gdapi.globaldata.net.au/docs/guides/dvs/sample-documents.md)
- [DVS: Out of Scope Documents](https://gdapi.globaldata.net.au/docs/guides/dvs/out-of-scope-documents.md)
- [ID Pass: ID Pass Overview](https://gdapi.globaldata.net.au/docs/guides/idpass/id-pass-overview.md)
- [ID Pass validation: ID Pass validation strategies](https://gdapi.globaldata.net.au/docs/guides/idpass-validation/id-pass-validation-strategies.md)
- [ID Pass validation: ID Pass - DVS mode](https://gdapi.globaldata.net.au/docs/guides/idpass-validation/id-pass---dvs-mode.md)
- [ID Pass validation: ID Pass - IDSP mode](https://gdapi.globaldata.net.au/docs/guides/idpass-validation/id-pass---idsp-mode.md)
- [ID Pass validation: ID Pass - Basic mode](https://gdapi.globaldata.net.au/docs/guides/idpass-validation/id-pass---basic-mode.md)
- [ID Pass validation: Learn more](https://gdapi.globaldata.net.au/docs/guides/idpass-validation/learn-more.md)
- [ID Pass workflow: User Journey](https://gdapi.globaldata.net.au/docs/guides/idpass-workflow/user-journey.md)
- [Custom ID verification workflow: Custom Identity Verification](https://gdapi.globaldata.net.au/docs/guides/id-verification-custom-workflow/custom-identity-verification.md)

## API reference
- [Common error responses](https://gdapi.globaldata.net.au/docs/reference/general/common-error-responses.md): The shared error envelope and the 4xx and 5xx codes every endpoint can return.
- [Rate limit headers](https://gdapi.globaldata.net.au/docs/reference/general/rate-limit-headers.md): The headers on every response that tell you where you stand against your limit.

### Address
- [Address Autocomplete](https://gdapi.globaldata.net.au/docs/reference/address_autocomplete.md): GET /address_autocomplete
- [Address Validate](https://gdapi.globaldata.net.au/docs/reference/address_validate.md): POST /address_validate
- [Address Validate Bulk](https://gdapi.globaldata.net.au/docs/reference/address_validate_bulk.md): POST /address_validate_bulk
- [Address Lookup by Contact](https://gdapi.globaldata.net.au/docs/reference/address_lookup_by_contact.md): GET /address_lookup_by_contact
- [Property Detail](https://gdapi.globaldata.net.au/docs/reference/property_detail.md): GET /property_detail
- [Real Estate Search](https://gdapi.globaldata.net.au/docs/reference/realestate_search.md): POST /realestate_search
- [Real Estate Search (Bulk)](https://gdapi.globaldata.net.au/docs/reference/realestate_searches.md): POST /realestate_searches

### Adverse Media
- [Adverse Media Check](https://gdapi.globaldata.net.au/docs/reference/adverse_media_check.md): POST /adverse_media_check

### ASIC
- [ASIC Banned Persons Search](https://gdapi.globaldata.net.au/docs/reference/asic_banned_persons.md): POST /asic_banned_persons
- [ASIC Search](https://gdapi.globaldata.net.au/docs/reference/asic_search.md): POST /asic_search
- [ASIC Search Bulk](https://gdapi.globaldata.net.au/docs/reference/asic_searches.md): POST /asic_searches
- [ASIC Extract Person Search](https://gdapi.globaldata.net.au/docs/reference/asic_extract_person_search.md): POST /asic_extract_person_search
- [ASIC Extract Company Search](https://gdapi.globaldata.net.au/docs/reference/asic_extract_company_search.md): POST /asic_extract_company_search
- [ASIC ID Check](https://gdapi.globaldata.net.au/docs/reference/asic_id_check.md): POST /asic_id_check
- [ASIC Extract](https://gdapi.globaldata.net.au/docs/reference/asic_extract.md): POST /asic_extract
- [Retrieve ASIC Extract](https://gdapi.globaldata.net.au/docs/reference/asic_extract_show.md): GET /asic_extract/{api_reference}

### Business Check
- [Business Check](https://gdapi.globaldata.net.au/docs/reference/business_check.md): POST /business_check
- [Business Check Bulk](https://gdapi.globaldata.net.au/docs/reference/business_checks.md): POST /business_checks

### Business Intelligence
- [Create a Business Intelligence Request](https://gdapi.globaldata.net.au/docs/reference/business_intelligence.md): POST /business_intelligence
- [Retrieve a Business Intelligence Request](https://gdapi.globaldata.net.au/docs/reference/business_intelligence_results.md): GET /business_intelligence/{request_uuid}

### Caspar
- [Caspar Person Search](https://gdapi.globaldata.net.au/docs/reference/caspar_person_search.md): POST /caspar_person_search
- [Caspar Person Autotrace](https://gdapi.globaldata.net.au/docs/reference/caspar_person_autotrace.md): POST /caspar_person_autotrace

### Company Risk
- [ASIC Company Search](https://gdapi.globaldata.net.au/docs/reference/asic_company_search.md): POST /asic_company_search
- [Company Risk Report](https://gdapi.globaldata.net.au/docs/reference/company_risk.md): POST /company_risk
- [Retrieve Company Risk Report](https://gdapi.globaldata.net.au/docs/reference/company_risk_show.md): GET /company_risk/{api_reference}

### Court Check
- [Court Check](https://gdapi.globaldata.net.au/docs/reference/court_check.md): POST /court_check
- [Court Check Multiple](https://gdapi.globaldata.net.au/docs/reference/court_check_multiple.md): POST /court_check_multiple

### Deceased Check
- [ADC Check](https://gdapi.globaldata.net.au/docs/reference/adc_check.md): POST /adc_check
- [ADC Check Bulk](https://gdapi.globaldata.net.au/docs/reference/adc_checks.md): POST /adc_checks

### DVS
- [Validate with the AEC](https://gdapi.globaldata.net.au/docs/reference/dvs.aec.md): POST /dvs/aec
- [Validate an ASIC/MSIC Card](https://gdapi.globaldata.net.au/docs/reference/dvs.asic.md): POST /dvs/asic
- [Validate a birth certificate](https://gdapi.globaldata.net.au/docs/reference/dvs.birth_cert.md): POST /dvs/birth_cert
- [Validate a Centrelink concession card](https://gdapi.globaldata.net.au/docs/reference/dvs.centrelink.md): POST /dvs/centrelink
- [Validate a citizenship certificate](https://gdapi.globaldata.net.au/docs/reference/dvs.citizenship.md): POST /dvs/citizenship
- [Validate a death certificate](https://gdapi.globaldata.net.au/docs/reference/dvs.death_cert.md): POST /dvs/death_cert
- [Validate a drivers licence](https://gdapi.globaldata.net.au/docs/reference/dvs.driver_licence.md): POST /dvs/drivers_licence
- [Validate an ImmiCard](https://gdapi.globaldata.net.au/docs/reference/dvs.immicard.md): POST /dvs/immicard
- [Validate a marriage certificate](https://gdapi.globaldata.net.au/docs/reference/dvs.marriage.md): POST /dvs/marriage
- [Validate a Medicare card](https://gdapi.globaldata.net.au/docs/reference/dvs.medicare.md): POST /dvs/medicare
- [Validate a change of name certificate](https://gdapi.globaldata.net.au/docs/reference/dvs.name_change.md): POST /dvs/name_change
- [Validate Australian travel documents](https://gdapi.globaldata.net.au/docs/reference/dvs.passport.md): POST /dvs/passport
- [Validate a registration by descent certificate](https://gdapi.globaldata.net.au/docs/reference/dvs.reg_by_descent.md): POST /dvs/reg_by_descent
- [Validate Australian visas](https://gdapi.globaldata.net.au/docs/reference/dvs.visa.md): POST /dvs/visa

### Email
- [Check email deliverability](https://gdapi.globaldata.net.au/docs/reference/email_ping.md): GET /email_ping

### Global Data Check
- [Global Data Check](https://gdapi.globaldata.net.au/docs/reference/globaldata_check.md): POST /globaldata_check

### ID Document
- [Extract ID Document Data & Face Image](https://gdapi.globaldata.net.au/docs/reference/id_extract.md): POST /id_extract

### ID Pass
- [Create an ID Pass](https://gdapi.globaldata.net.au/docs/reference/idpass_register.md): POST /idpass/register
- [Read an ID Pass](https://gdapi.globaldata.net.au/docs/reference/idpass_details.md): POST /idpass/details
- [Cancel an ID Pass](https://gdapi.globaldata.net.au/docs/reference/idpass_cancel.md): POST /idpass/cancel

### Likeness Check
- [Perform a Likeness (Face Similarity) Check](https://gdapi.globaldata.net.au/docs/reference/likeness_check.md): POST /likeness_check

### Liveness Check
- [Create a Liveness Check](https://gdapi.globaldata.net.au/docs/reference/liveness_check.md): POST /liveness_check
- [Retrieve a Liveness Check Result](https://gdapi.globaldata.net.au/docs/reference/liveness_check_result.md): GET /liveness_check

### NZ Identity Verification
- [NZ Driver Licence Check](https://gdapi.globaldata.net.au/docs/reference/nz_driver_licence.md): POST /nz_driver_licence

### Payroll and Super Check
- [Payroll Check](https://gdapi.globaldata.net.au/docs/reference/payroll_check.md): POST /payroll_check
- [Super Check](https://gdapi.globaldata.net.au/docs/reference/super_check.md): POST /super_check
- [Payroll and Super Check](https://gdapi.globaldata.net.au/docs/reference/payroll_super_check.md): POST /payroll_super_check

### Person
- [Person History](https://gdapi.globaldata.net.au/docs/reference/person_history.md): POST /person_history
- [Marketing Contact Lookup](https://gdapi.globaldata.net.au/docs/reference/marketing_contact_lookup.md): POST /marketing_contact_lookup
- [Deceased Check](https://gdapi.globaldata.net.au/docs/reference/deceased_check.md): POST /deceased_check
- [Enhance Record Plus](https://gdapi.globaldata.net.au/docs/reference/enhance_record_plus.md): POST /enhance_record_plus
- [Banned and Disqualified Person Search](https://gdapi.globaldata.net.au/docs/reference/banned_disqualified_persons.md): POST /banned_disqualified_persons

### Phone
- [Check phone connectivity](https://gdapi.globaldata.net.au/docs/reference/phone_ping.md): GET /phone_ping
- [Check phone DNC status](https://gdapi.globaldata.net.au/docs/reference/phone_dnc.md): GET /phone_dnc
- [Phone Contact Lookup](https://gdapi.globaldata.net.au/docs/reference/phone_contact_lookup.md): POST /phone_contact_lookup
- [Phone Contact Validate](https://gdapi.globaldata.net.au/docs/reference/phone_contact_validate.md): POST /phone_contact_validate

### Sanctions
- [PEP / Sanction Search](https://gdapi.globaldata.net.au/docs/reference/pep_sanction_check.md): POST /pep_sanction_check
- [PEP / Sanction Bulk Search](https://gdapi.globaldata.net.au/docs/reference/pep_sanction_check_bulk.md): POST /pep_sanction_checks

### Social
- [Social Check](https://gdapi.globaldata.net.au/docs/reference/social_check.md): GET /social_check
- [Social Contact Expand](https://gdapi.globaldata.net.au/docs/reference/social_contact_expand.md): POST /social_contact_expand

### Test
- [Test endpoint](https://gdapi.globaldata.net.au/docs/reference/test.md): GET /test

### UK Companies House
- [Company House Search](https://gdapi.globaldata.net.au/docs/reference/company_house_search.md): POST /company_house_search
- [Company House Report](https://gdapi.globaldata.net.au/docs/reference/company_house_report.md): POST /company_house_report
- [Retrieve Company House Report](https://gdapi.globaldata.net.au/docs/reference/company_house_report_show.md): GET /company_house_report/{api_reference}
- [Company House Officer Search](https://gdapi.globaldata.net.au/docs/reference/company_house_officer_search.md): POST /company_house_officer_search
- [Company House Officer Report](https://gdapi.globaldata.net.au/docs/reference/company_house_officer_report.md): POST /company_house_officer_report
- [Retrieve Company House Officer Report](https://gdapi.globaldata.net.au/docs/reference/company_house_officer_report_show.md): GET /company_house_officer_report/{api_reference}
- [Company House Document](https://gdapi.globaldata.net.au/docs/reference/company_house_document.md): GET /company_house_document/{documentId}
- [UK Business Check](https://gdapi.globaldata.net.au/docs/reference/uk_business_check.md): POST /uk_business_check
- [UK Business Check (Bulk)](https://gdapi.globaldata.net.au/docs/reference/uk_business_checks.md): POST /uk_business_checks