ABRXMLSearch

Click here for a complete list of operations.

SearchByABNStatus

Search for ABNs by postcode and selected status. Returns a list of matching ABNs.

Test

To test the operation using the HTTP GET protocol, complete the form and click the 'Invoke' button.

 (Y/N)
 (Y/N)

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST https://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx HTTP/1.1
Host: abr.business.gov.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://abr.business.gov.au/ABRXMLSearchRPC/SearchByABNStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://abr.business.gov.au/ABRXMLSearchRPC/" xmlns:types="http://abr.business.gov.au/ABRXMLSearchRPC/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:SearchByABNStatus>
      <postcode xsi:type="xsd:string">string</postcode>
      <activeABNsOnly xsi:type="xsd:string">string</activeABNsOnly>
      <currentGSTRegistrationOnly xsi:type="xsd:string">string</currentGSTRegistrationOnly>
      <entityTypeCode xsi:type="xsd:string">string</entityTypeCode>
      <authenticationGuid xsi:type="xsd:string">string</authenticationGuid>
    </tns:SearchByABNStatus>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://abr.business.gov.au/ABRXMLSearchRPC/" xmlns:types="http://abr.business.gov.au/ABRXMLSearchRPC/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:SearchByABNStatusResponse>
      <SearchByABNStatusResult href="#id1" />
    </tns:SearchByABNStatusResponse>
    <tns:Payload id="id1" xsi:type="tns:Payload">
      <Request href="#id2" />
      <Response href="#id3" />
    </tns:Payload>
    <tns:ExternalRequest id="id2" xsi:type="tns:ExternalRequest">
      <ExternalRequestBody xsi:type="type" />
    </tns:ExternalRequest>
    <tns:Response id="id3" xsi:type="tns:Response">
      <UsageStatement xsi:type="xsd:string">string</UsageStatement>
      <DateRegisterLastUpdated xsi:type="xsd:dateTime">dateTime</DateRegisterLastUpdated>
      <DateTimeRetrieved xsi:type="xsd:dateTime">dateTime</DateTimeRetrieved>
      <ResponseBody xsi:type="type" />
    </tns:Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST https://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx HTTP/1.1
Host: abr.business.gov.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://abr.business.gov.au/ABRXMLSearchRPC/" xmlns:types="http://abr.business.gov.au/ABRXMLSearchRPC/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:SearchByABNStatus>
      <postcode xsi:type="xsd:string">string</postcode>
      <activeABNsOnly xsi:type="xsd:string">string</activeABNsOnly>
      <currentGSTRegistrationOnly xsi:type="xsd:string">string</currentGSTRegistrationOnly>
      <entityTypeCode xsi:type="xsd:string">string</entityTypeCode>
      <authenticationGuid xsi:type="xsd:string">string</authenticationGuid>
    </tns:SearchByABNStatus>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://abr.business.gov.au/ABRXMLSearchRPC/" xmlns:types="http://abr.business.gov.au/ABRXMLSearchRPC/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:SearchByABNStatusResponse>
      <rpc:result xmlns="">SearchByABNStatusResult</rpc:result>
      <SearchByABNStatusResult soapenc:id="id0" xsi:type="tns:Payload">
        <Request soapenc:id="id1" xsi:type="tns:ExternalRequest">
          <ExternalRequestBody xsi:type="type" />
        </Request>
        <Response soapenc:id="id2" xsi:type="tns:Response">
          <UsageStatement xsi:type="xsd:string">string</UsageStatement>
          <DateRegisterLastUpdated xsi:type="xsd:dateTime">dateTime</DateRegisterLastUpdated>
          <DateTimeRetrieved xsi:type="xsd:dateTime">dateTime</DateTimeRetrieved>
          <ResponseBody xsi:type="type" />
        </Response>
      </SearchByABNStatusResult>
    </tns:SearchByABNStatusResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /ABRXMLSearch.asmx/SearchByABNStatus?postcode=string&activeABNsOnly=string&currentGSTRegistrationOnly=string&entityTypeCode=string&authenticationGuid=string HTTP/1.1
Host: abr.business.gov.au

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ABRPayloadSearchResults xmlns="http://abr.business.gov.au/ABRXMLSearchRPC/literalTypes">
  <request />
  <response>
    <usageStatement>string</usageStatement>
    <dateRegisterLastUpdated>date</dateRegisterLastUpdated>
    <dateTimeRetrieved>dateTime</dateTimeRetrieved>
  </response>
</ABRPayloadSearchResults>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /ABRXMLSearch.asmx/SearchByABNStatus HTTP/1.1
Host: abr.business.gov.au
Content-Type: application/x-www-form-urlencoded
Content-Length: length

postcode=string&activeABNsOnly=string&currentGSTRegistrationOnly=string&entityTypeCode=string&authenticationGuid=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ABRPayloadSearchResults xmlns="http://abr.business.gov.au/ABRXMLSearchRPC/literalTypes">
  <request />
  <response>
    <usageStatement>string</usageStatement>
    <dateRegisterLastUpdated>date</dateRegisterLastUpdated>
    <dateTimeRetrieved>dateTime</dateTimeRetrieved>
  </response>
</ABRPayloadSearchResults>