General reference · eKYB Reference / eKYB Prefill Coverage

Australia

eKYB Prefill in Australia leverages Australia's source of truth to automatically retrieve and populate business information based on a company's registration number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

Source

Country Source Description
Australia AU_KYB_PREFILL Returns matching Australian business details from Australia's source of truth for pre-fill.

Direct API approach

For general integration notes and shared response semantics, see the eKYB Prefill API Reference.

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

Endpoint

POST /omni/externalVerification/ekyb-prefill

Request parameters

Parameter Required Description
plugins Mandatory String array. Must be ["ekyb-prefill"]. Specifies the Prefill flow.
source Mandatory String. Must be AU_KYB_PREFILL. Identifies the Prefill source.
country Mandatory String. Two-letter Alpha-2 country code. Must be AU.
taxId Mandatory String. ACN or ABN. See Tax ID formats for details.
businessName Optional String. Registered or trading business name, used to verify the match against the source of truth.
address Optional String. Business address, used to verify the match against the source of truth.

Tax ID formats

Australia uses two business identifier formats. Input must be numeric only — no other lengths or formats are accepted. Requests with an invalid format return a 400 error.

Entity Type Format
ACN (Australian Company Number) 9 numeric digits (e.g. 000014675)
ABN (Australian Business Number) 11 numeric digits (e.g. 88000014675)

Sample request

{
    "plugins": ["ekyb-prefill"],
    "source": "AU_KYB_PREFILL",
    "country": "AU",
    "taxId": "51 824 753 556",
    "businessName": "ACME GROUP LIMITED",
    "address": "123 Example Street, Sydney NSW 2000, Australia"
}

Sample response

The Prefill response returns business data retrieved directly from the source of truth. Passthrough fields are returned as-is from the source, without fuzzy matching or verification scoring. Match fields (nameMatch, addressMatch) are only returned when the corresponding input (businessName, address) was submitted.

{
    "kyb-prefill": [
        {
            "tin": "51824753556",
            "vatNo": "51824753556",
            "name": "ACME GROUP LIMITED",
            "nameMatch": "Verified",
            "address": "123 Example Street, Sydney NSW 2000, Australia",
            "addressMatch": "Verified",
            "city": "Sydney",
            "postalCode": "2000",
            "entityType": "Australian Public Company",
            "registrationStatus": "Active",
            "registrationDate": "1998-03-15",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industry": "Retail Trade",
            "industryDesc": "Supermarket, grocery, and general retail trade operations",
            "turnover": { "currency": "AUD", "value": 69346000000 },
            "otherAddresses": [
                {
                    "type": "Principal Place of Business",
                    "otherAddress": "456 Sample Avenue, Melbourne VIC 3000, Australia"
                }
            ],
            "directors": [
                { "name": "John Sample Smith", "positionName": "Director" },
                { "name": "Jane Example Doe", "positionName": "Director" }
            ],
            "otherNames": [
                { "name": "ACME Retail", "businessNameType": "Main Trading Name" },
                { "name": "ACME Supermarkets", "businessNameType": "Main Trading Name" }
            ],
            "activityDesc": "Supermarket and Grocery Stores"
        }
    ]
}

Info

Some fields — shareholders, employeeCount, ultimateParent, and immediateParent — are not always present in the response. They are only returned when the source of truth has the underlying data (for example, ultimateParent/immediateParent are omitted when the entity is not itself a subsidiary of another company, and shareholders/employeeCount may be unavailable depending on the entity's filing history). This is expected and does not indicate an error.

Response fields

Key Value Description
tin Registration number The tax ID submitted in the request (ACN), as returned and confirmed by the source of truth.
vatNo Registration number The ABN associated with the business, as returned by the source of truth.
name Business name The registered legal name of the business as returned from the source of truth.
nameMatch Verified, Approximate Match, Unverified Match result comparing the submitted businessName against the registered name. Only returned when businessName is submitted.
address Address The registered business address as returned from the source of truth.
addressMatch Verified, Approximate Match, Unverified Match result comparing the submitted address against the registered address. Only returned when address is submitted.
city City The city associated with the registered business address.
postalCode Postal code The postal code associated with the registered business address.
entityType Entity type The legal entity type of the business (e.g. Australian Public Company).
registrationStatus Active, Expired, Unknown, Not Found Current registration status of the business. See Registration status values.
registrationDate Date The date the business was registered.
creditRating Rating value (e.g. A, C) The business's credit rating, as returned from the source of truth.
creditRatingDescription Description (e.g. Very Low Risk, Moderate Risk) Human-readable description of the credit rating.
industry Industry sector The primary industry sector associated with the business.
industryDesc Industry description Description of the business's main activity.
turnover {currency, value} object The business's latest reported turnover figure. May not be present for all companies (e.g. smaller/private entities with no filed financials).
otherAddresses Array of {type, otherAddress} Addresses associated with the business other than the main registered address, if any.
shareholders Array of {name, percentSharesHeld} Shareholder information, if available.
directors Array of {name, positionName} Directors associated with the business, if available.
otherNames Array of {name, businessNameType} Other registered or trading names associated with the business, if available.
activityDesc Activity description Description of the business's classified activity.
employeeCount Number Latest reported number of employees, if available.
ultimateParent {name, country, registrationNumber} The business's ultimate parent company, if the business is a subsidiary.
immediateParent {name, country, registrationNumber} The business's immediate parent company, if the business is a subsidiary.

Registration status values

Status Description
Active The business is currently registered and active.
Expired The business registration has lapsed.
Unknown The registration status could not be determined.
Not Found The business is inactive or could not be found in the source of truth.

Error responses

For standard HTTP response codes, see the API Error Response page. Australia Prefill returns the following country-specific 400 errors.

taxId is missing, empty, or not 9 or 11 numeric digits:

{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid ACN (9 digits) or ABN (11 digits), numeric only",
    "path": "/omni/externalVerification/ekyb-prefill"
}

Any mandatory field (plugins, source, country, or taxId) is missing:

{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}

Single Session Dashboard results

Prefill results are available on the Business tab in single Session view.

Was this page helpful?