Company lookup methods

Company lookup methods take company name or ABN as an input and perform search to return company information that matches the search parameters.

The API Specification, also available on each method below - it requires valid username and password.

companyLookup (AU only) Provide a number of search options for Australian Company Lookup by ABN, ACN, name etc.

companyLookup

Search by company name, ABN, ACN or other filters, returning a list of the results.

Resource URL


    POST  	
    https://hosted.mastersoftgroup.com/harmony/rest/au/companyLookup
    
    GET	(search by Name)
    https://hosted.mastersoftgroup.com/harmony/rest/au/companyLookup?callback=jsonCallback__companyLookup&Authorization=XXXX&name=abc    
    
    GET	(search active only and isCurrentIndicator marked as YES by Name)
    https://hosted.mastersoftgroup.com/harmony/rest/au/companyLookup?callback=jsonCallback__companyLookup&Authorization=XXXX&name=abc&config=active:Y;current:Y    
    
    GET	(search by ABN)
    https://hosted.mastersoftgroup.com/harmony/rest/au/companyLookup?callback=jsonCallback__companyLookup&Authorization=XXXX&apiName=SearchByABNv201408&name=3XXXX    
    

Request

The request body is a CompanyRestRequest object:

	
    Lookup by the Company Name
    {
        "payload": { "name": "abc" }
    }
    
    Lookup active only and isCurrentIndicator marked as YES by the Company Name
    {
        "payload": { "name": "abc" },
        "optionalConfig": "active:Y;current:Y"
    }
    
    Lookup by the ASIC number (ACN or ARBN)
    {
        "payload": { "name":"xxxx6693" }, 
        "apiName": "SearchByASICv201408"
    }
    

Response

The response body is a CompanyRestResponse object:


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "name": "xxxx",
                "abn": "xxxxx",
                "statecode": "VIC",
                "postcode": "3144",
                "status": "Active",
                "legalName": null,
                "acn": null,
                "isCurrentIndicator": "Y"
            },
            ....
        ]
    }