ABN Validation API

Validate Australian Business Numbers (ABN) with access to the Australian Business Register (ABR) data. Verify business registration status, GST compliance, entity types, and business names for KYC, due diligence, and fraud prevention.

The ABN validation API provides comprehensive business verification by accessing official government data. Use this endpoint to automate customer onboarding, supplier verification, and compliance checks with accurate, up-to-date business information from the Australian Business Register.

More about Australian Business Number on ABR website →

Model

Specific structure of the data that represents the entity within the API. It defines the attributes and their data types associated with the entity.

It's important to note that you'll need to retrieve the complete identifier for an entity each time you require its complete model. This can be achieved by utilizing the find endpoint to locate the entity and then using the retrieved identifier to call the retrieve endpoint for complete model.

This API prioritizes efficient data transmission and minimizes response sizes. While the retrieve endpoint provides the complete data model for a requested entity, it adheres to the principle of "sparse representation." This means that certain properties within the model might be omitted if they lack any relevant data for the specific entity.

  • Name
    id
    Type
    string
  • Name
    abn
    Type
    string
  • Name
    asicNumber
    Type
    string
  • Name
    asicNumberType
    Type
    string
  • Name
    entityType
    Type
    string
  • Name
    entityTypeDescription
    Type
    string
  • Name
    entities
    Type
    object
    Description
    • Name
      main
      Type
      object
      Description
      • Name
        type
        Type
        string
      • Name
        name
        Type
        string
      • Name
        state
        Type
        string
      • Name
        postcode
        Type
        string
    • Name
      legal
      Type
      object
      Description
      • Name
        type
        Type
        string
      • Name
        title
        Type
        string
      • Name
        givenName
        Type
        string
      • Name
        familyName
        Type
        string
      • Name
        state
        Type
        string
      • Name
        postcode
        Type
        string
    • Name
      other
      Type
      object
      Description
      • Name
        type
        Type
        string
      • Name
        name
        Type
        string
      • Name
        state
        Type
        string
      • Name
        postcode
        Type
        string
    • Name
      dgr
      Type
      object
      Description
      • Name
        type
        Type
        string
      • Name
        name
        Type
        string
  • Name
    dateOfLastUpdate
    Type
    string
  • Name
    dateOfGstStatus
    Type
    string
  • Name
    dateOfDgrStatus
    Type
    string
  • Name
    dateOfAbnStatus
    Type
    string
  • Name
    isReplaced
    Type
    boolean
  • Name
    isGst
    Type
    boolean
  • Name
    isAbn
    Type
    boolean
GET/abr/business/number/find/

Find

This API endpoint utilizes a full-text search functionality to help you locate entities that match with your search criteria. By providing a query, system will scan through all available data, pinpointing all entities that contain relevant keywords or phrases.

The find endpoint performs full-text search across the following fields: abn, entityMainName, entityLegalGivenName, entityLegalFamilyName, entityOtherName, entityDgrName.

This API endpoint prioritizes speed and efficiency by returning a partial model with a limited set of properties for each matching entity. To retrieve the complete entity details, you can leverage retrieve API endpoint designed for specific entity retrieval based on unique identifiers.

Mandatory headers

  • Name
    x-api-key
    Type
    string
    Description
    A valid API key obtained through active subscription must be included in the header in order for the endpoint to work.

Mandatory attributes

  • Name
    query
    Type
    string
    Description
    This mandatory attribute represents the search query you wish to execute. The query string must be at least three characters long for the search to function effectively.

Optional attributes

  • Name
    offset
    Type
    integer
    Description
    Pagination is implemented to manage potentially large result sets. This optional parameter allows you to specify the number of entities to skip before retrieving the desired page of results.

Request

GET
/abr/business/number/find/
curl "https://api.vigil.sh/abr/business/number/find/?query={query}" \
  -H 'x-api-key: {api-key}'

Response

{
  "results": [
    {
      "id": "hqu-qz5oc2ZWh13sxRzLwgeEYuiZgX7imw==",
      "abn": "12345678901"
    },
    // ...
  ],
  "resultsTotal": 3
}
GET/abr/business/number/

Retrieve

This API endpoint utilizes a data retrieval functionality to help you access the entity associated with a provided unique identifier. When you provide a unique identifier, the system scans through all available data in order to pinpoint the exact entity that matches that identifier.

This API endpoint prioritizes the integrity and comprehensiveness of your data by returning the complete data model with the entire set of properties for the matching entity. To find the different entity, you can leverage find API endpoint designed for full-text search based on your query.

Mandatory headers

  • Name
    x-api-key
    Type
    string
    Description
    A valid API key obtained through active subscription must be included in the header in order for the endpoint to work.

Mandatory attributes

  • Name
    id
    Type
    string
    Description
    This mandatory attribute represents the unique identifier associated with specific entity. The unique identifiers used within this API are not static values. Instead, they employ a rotation mechanism, meaning they change frequently, often with nearly every request.

Request

GET
/abr/business/number/
curl "https://api.vigil.sh/abr/business/number/?id={id}" \
  -H 'x-api-key: {api-key}'

Response

{
  "abn": "12345678901",
  "asicNumber": "123456789",
  "entityType": "PRV",
  "entityTypeDescription": "Australian Private Company",
  "entities": {
    "main": {
      "type": "MN",
      "name": "TERRA AUSTRALIS PTY. LTD.",
      "state": "NSW",
      "postcode": "2000"
    },
    "legal": {},
    "other": {
      "type": "BN",
      "name": "TERRA AUSTRALIS COLLEGE"
    },
    "dgr": {}
  },
  "dateOfLastUpdate": "01/01/2020",
  "dateOfGstStatus": "01/01/2000",
  "dateOfAbnStatus": "01/01/2010"
}