ABRXMLSearch

Click here for a complete list of operations.

ABRSearchByNameAdvanced

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: "http://abr.business.gov.au/ABRXMLSearch/ABRSearchByNameAdvanced"

<?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:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ABRSearchByNameAdvanced xmlns="http://abr.business.gov.au/ABRXMLSearch/">
      <authenticationGuid>string</authenticationGuid>
      <externalNameSearch>
        <name>string</name>
        <filters>
          <nameType>
            <tradingName>string (Y/N)</tradingName>
            <legalName>string (Y/N)</legalName>
          </nameType>
          <postcode>int</postcode>
          <stateCode>
            <QLD>string (Y/N)</QLD>
            <NT>string (Y/N)</NT>
            <SA>string (Y/N)</SA>
            <WA>string (Y/N)</WA>
            <VIC>string (Y/N)</VIC>
            <ACT>string (Y/N)</ACT>
            <TAS>string (Y/N)</TAS>
            <NSW>string (Y/N)</NSW>
          </stateCode>
        </filters>
        <searchWidth>string</searchWidth>
        <minimumScore>int</minimumScore>
      </externalNameSearch>
    </ABRSearchByNameAdvanced>
  </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:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ABRSearchByNameAdvancedResponse xmlns="http://abr.business.gov.au/ABRXMLSearch/">
      <ABRPayloadSearchResults>
        <request />
        <response>
          <usageStatement>string</usageStatement>
          <dateRegisterLastUpdated>date</dateRegisterLastUpdated>
          <dateTimeRetrieved>dateTime</dateTimeRetrieved>
        </response>
      </ABRPayloadSearchResults>
    </ABRSearchByNameAdvancedResponse>
  </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:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ABRSearchByNameAdvanced xmlns="http://abr.business.gov.au/ABRXMLSearch/">
      <authenticationGuid>string</authenticationGuid>
      <externalNameSearch>
        <name>string</name>
        <filters>
          <nameType>
            <tradingName>string (Y/N)</tradingName>
            <legalName>string (Y/N)</legalName>
          </nameType>
          <postcode>int</postcode>
          <stateCode>
            <QLD>string (Y/N)</QLD>
            <NT>string (Y/N)</NT>
            <SA>string (Y/N)</SA>
            <WA>string (Y/N)</WA>
            <VIC>string (Y/N)</VIC>
            <ACT>string (Y/N)</ACT>
            <TAS>string (Y/N)</TAS>
            <NSW>string (Y/N)</NSW>
          </stateCode>
        </filters>
        <searchWidth>string</searchWidth>
        <minimumScore>int</minimumScore>
      </externalNameSearch>
    </ABRSearchByNameAdvanced>
  </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:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ABRSearchByNameAdvancedResponse xmlns="http://abr.business.gov.au/ABRXMLSearch/">
      <ABRPayloadSearchResults>
        <request />
        <response>
          <usageStatement>string</usageStatement>
          <dateRegisterLastUpdated>date</dateRegisterLastUpdated>
          <dateTimeRetrieved>dateTime</dateTimeRetrieved>
        </response>
      </ABRPayloadSearchResults>
    </ABRSearchByNameAdvancedResponse>
  </soap12:Body>
</soap12:Envelope>