openapi: 3.0.0
info:
  description: >-
    The ABN Lookup apis allow you to incorporate ABN information and search
    capabilities into your own applications which provide a number of search
    options that are not available through the ABN Lookup website. For example,
    through the apis you can request a list of ABNs for a selected postcode with
    optional filters such as date updated, date registered, etc. or control how
    many matching names are returned by the name search or create advanced name
    search queries to better control search results
  version: 1.0.0
  title: ABNLookup
  termsOfService: https://abr.business.gov.au/Documentation/WebServiceMethods
tags:
  - name: SearchByABN
    description: Search by using ABN (Australian Business Number)
  - name: SearchByASIC
    description: Search by using ASIC (Australian Security & Investments Commission)
  - name: ABRSearchByNameAdvancedSimpleProtocol
    description: Advance search with flags
  - name: SearchWithFilters
    description: Search using filters
paths:
  /SearchByABNv202001:
    get:
      tags:
        - SearchByABN
      summary: Search by ABN with the latest and greatest v202001 standards
      description: ''
      operationId: ''
      parameters:
        - name: searchString
          in: query
          required: true
          schema:
            type: string
            example: "49 096 776 895"
        - name: includeHistoricalDetails
          in: query
          required: true
          schema:
            type: string
            example: N
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
            example: 12ec4a53-36ac-4a2b-81a2-516e201ecb93
      responses:
        '200':
          $ref: '#/components/responses/200'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
        - SearchByABN
      summary: Search by ABN with v202001 standards
      description: ''
      operationId: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchByABNv202001_Request'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /SearchByASICv201408:
    get:
      tags:
        - SearchByASIC
      summary: Search by ASIC with v201408 standards
      description: ''
      operationId: ''
      parameters:
        - name: searchString
          in: query
          required: true
          schema:
            type: string
        - name: includeHistoricalDetails
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
    post:
      tags:
        - SearchByASIC
      summary: Search by ASIC with v201408 standards
      description: ''
      operationId: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchByASICv201408_Request'
          application/xml:
            schema:
              $ref: '#/components/schemas/SearchByASICv201408_Request'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /SearchByPostcode:
    get:
      tags:
        - SearchWithFilters
      summary: Search by using Postcode as a filter
      description: ''
      operationId: ''
      parameters:
        - name: postcode
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /SearchByABNStatus:
    get:
      tags:
        - SearchWithFilters
      summary: Search by using ABN status as a filter
      description: ''
      operationId: ''
      parameters:
        - name: postcode
          in: query
          required: true
          schema:
            type: string
        - name: activeABNsOnly
          in: query
          required: true
          schema:
            type: string
        - name: currentGSTRegistrationOnly
          in: query
          required: true
          schema:
            type: string
        - name: entityTypeCode
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /SearchByUpdateEvent:
    get:
      tags:
        - SearchWithFilters
      summary: Search by using update event as a filter
      description: ''
      operationId: ''
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
        - name: postcode
          in: query
          required: true
          schema:
            type: string
        - name: legalName
          in: query
          required: true
          schema:
            type: string
        - name: tradingName
          in: query
          required: true
          schema:
            type: string
        - name: businessName
          in: query
          required: true
          schema:
            type: string
        - name: activeABNsOnly
          in: query
          required: true
          schema:
            type: string
        - name: NSW
          in: query
          required: true
          schema:
            type: string
        - name: SA
          in: query
          required: true
          schema:
            type: string
        - name: ACT
          in: query
          required: true
          schema:
            type: string
        - name: VIC
          in: query
          required: true
          schema:
            type: string
        - name: WA
          in: query
          required: true
          schema:
            type: string
        - name: NT
          in: query
          required: true
          schema:
            type: string
        - name: QLD
          in: query
          required: true
          schema:
            type: string
        - name: TAS
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
        - name: searchWidth
          in: query
          required: true
          schema:
            type: string
        - name: minimumScore
          in: query
          required: true
          schema:
            type: string
        - name: maxSearchResults
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /SearchByRegistrationEvent:
    get:
      tags:
        - SearchWithFilters
      summary: Search by using Registration of an event as a filter
      description: ''
      operationId: ''
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
        - name: postcode
          in: query
          required: true
          schema:
            type: string
        - name: legalName
          in: query
          required: true
          schema:
            type: string
        - name: tradingName
          in: query
          required: true
          schema:
            type: string
        - name: businessName
          in: query
          required: true
          schema:
            type: string
        - name: activeABNsOnly
          in: query
          required: true
          schema:
            type: string
        - name: NSW
          in: query
          required: true
          schema:
            type: string
        - name: SA
          in: query
          required: true
          schema:
            type: string
        - name: ACT
          in: query
          required: true
          schema:
            type: string
        - name: VIC
          in: query
          required: true
          schema:
            type: string
        - name: WA
          in: query
          required: true
          schema:
            type: string
        - name: NT
          in: query
          required: true
          schema:
            type: string
        - name: QLD
          in: query
          required: true
          schema:
            type: string
        - name: TAS
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
        - name: searchWidth
          in: query
          required: true
          schema:
            type: string
        - name: minimumScore
          in: query
          required: true
          schema:
            type: string
        - name: maxSearchResults
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /SearchByCharity:
    get:
      tags:
        - SearchWithFilters
      summary: Search by using charity information as a filter
      description: ''
      operationId: ''
      parameters:
        - name: postcode
          in: query
          required: true
          schema:
            type: string
        - name: state
          in: query
          required: true
          schema:
            type: string
        - name: charityTypeCode
          in: query
          required: true
          schema:
            type: string
        - name: concessionTypeCode
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
  /ABRSearchByNameAdvancedSimpleProtocol2017:
    get:
      tags:
        - ABRSearchByNameAdvancedSimpleProtocol
      summary: Advance search by name with 2017 protocol
      description: ''
      operationId: ''
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
        - name: postcode
          in: query
          required: true
          schema:
            type: string
        - name: legalName
          in: query
          required: true
          schema:
            type: string
        - name: tradingName
          in: query
          required: true
          schema:
            type: string
        - name: businessName
          in: query
          required: true
          schema:
            type: string
        - name: activeABNsOnly
          in: query
          required: true
          schema:
            type: string
        - name: NSW
          in: query
          required: true
          schema:
            type: string
        - name: SA
          in: query
          required: true
          schema:
            type: string
        - name: ACT
          in: query
          required: true
          schema:
            type: string
        - name: VIC
          in: query
          required: true
          schema:
            type: string
        - name: WA
          in: query
          required: true
          schema:
            type: string
        - name: NT
          in: query
          required: true
          schema:
            type: string
        - name: QLD
          in: query
          required: true
          schema:
            type: string
        - name: TAS
          in: query
          required: true
          schema:
            type: string
        - name: authenticationGuid
          in: query
          required: true
          schema:
            type: string
        - name: searchWidth
          in: query
          required: true
          schema:
            type: string
        - name: minimumScore
          in: query
          required: true
          schema:
            type: string
        - name: maxSearchResults
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
    post:
      tags:
        - ABRSearchByNameAdvancedSimpleProtocol
      summary: Advance search by name with 2017 protocol
      description: ''
      operationId: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/ABRSearchByNameAdvancedSimpleProtocol2017_Request
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/ABRSearchByNameAdvancedSimpleProtocol2017_Request
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
            application/json:
              schema:
                $ref: '#/components/schemas/ABRPayloadSearchResults'
        '404':
          description: Page not found
        '500':
          description: Internal server error
servers:
  - url: https://abr.business.gov.au/abrxmlsearch/abrxmlsearch.asmx
components:
  schemas:
    SearchByABNv202001_Request:
      type: object
      properties:
        searchString:
          type: string
        includeHistoricalDetails:
          type: string
        authenticationGuid:
          type: string
    SearchByASICv201408_Request:
      type: object
      properties:
        searchString:
          type: string
        includeHistoricalDetails:
          type: string
        authenticationGuid:
          type: string
    ABRSearchByNameAdvancedSimpleProtocol2017_Request:
      type: object

      properties:
        name:
          type: string
        postcode:
          type: string
        legalName:
          type: string
        tradingName:
          type: string
        businessName:
          type: string
        activeABNsOnly:
          type: string
        NSW:
          type: string
        SA:
          type: string
        ACT:
          type: string
        VIC:
          type: string
        WA:
          type: string
        NT:
          type: string
        QLD:
          type: string
        TAS:
          type: string
        authenticationGuid:
          type: string
        searchWidth:
          type: string
        minimumScore:
          type: string
        maxSearchResults:
          type: string
    ABRPayloadSearchResults:
      type: object
      properties:
        response:
          type: object
          properties:
            usageStatement:
              type: string
            dateRegisterLastUpdated:
              type: string
            dateTimeRetrieved:
              type: string
            exception:
              type: object
              properties:
                exceptionDescription:
                  type: string
                exceptionCode:
                  type: string
    ABRPayloadSearchResultsInJSON:
      type: object
      properties:
        payLoadSearchResults:
          $ref: '#/components/schemas/ABRPayloadSearchResults'
  responses:
    '200':
      description: successful operation
      content:
        text/xml; charset=utf-8:
          schema:
            $ref: '#/components/schemas/ABRPayloadSearchResults'
          examples:
            ABRPayloadSearchResultsExample:
              $ref: '#/components/examples/ABRPayloadSearchResultsExample'
        application/json:
          schema:
            $ref: '#/components/schemas/ABRPayloadSearchResultsInJSON'
          examples:
            ABRPayloadSearchResultsExample:
              $ref: '#/components/examples/ABRPayloadSearchResultsExample'
    '404':
      description: Page not found
    '500':
      description: Internal server error
  examples:
    ABRPayloadSearchResultsExample:
      value:
        ABRPayloadSearchResults:
          request:
            identifierSearchRequest:
              authenticationGUID: 12ec4a53-36ac-4a2b-81a2-516e201ecb93
              identifierType: ABN
              identifierValue: 49 096 776 895
              history: 'N'
          response:
            usageStatement: >-
              The Registrar of the ABR monitors the quality of the information available
              on this website and updates the information regularly. However, neither
              the Registrar of the ABR nor the Commonwealth guarantee that the
              information available through this service (including search results) is
              accurate, up to date, complete or accept any liability arising from the
              use of or reliance upon this site.
            dateRegisterLastUpdated: '2022-09-16'
            dateTimeRetrieved: '2022-09-16T20:34:16.3491489+10:00'
            businessEntity202001:
              recordLastUpdatedDate: '2018-11-26'
              ABN:
                identifierValue: '49096776895'
                isCurrentIndicator: 'Y'
                replacedFrom: '0001-01-01'
              entityStatus:
                entityStatusCode: Active
                effectiveFrom: '2001-05-24'
                effectiveTo: '0001-01-01'
              ASICNumber: 096776895
              entityType:
                entityTypeCode: PRV
                entityDescription: Australian Private Company
              goodsAndServicesTax:
                effectiveFrom: '2001-05-24'
                effectiveTo: '0001-01-01'
              mainName:
                organisationName: ACCENTURE AUSTRALIA PTY LTD
                effectiveFrom: '2013-08-28'
              mainTradingName:
                organisationName: ACCENTURE AUSTRALIA LTD.
                effectiveFrom: '2003-07-11'
              mainBusinessPhysicalAddress:
                stateCode: NSW
                postcode: '2000'
                effectiveFrom: '2018-11-26'
                effectiveTo: '0001-01-01'
              businessName:
                organisationName: ACCENTURE
                effectiveFrom: '2001-05-24'
          '_xmlns:xsd': 'http://www.w3.org/2001/XMLSchema'
          '_xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance'
          _xmlns: 'http://abr.business.gov.au/ABRXMLSearch/'