Credit Licensee

If you engage in credit activities you will generally need to have an Australian credit licence (unless you are exempt or authorised to engage in those activities as a representative of a credit licensee).

Credit activity includes: providing credit under a credit contract or consumer lease, benefiting from mortgages or guarantees relating to a credit contract, exercising rights or performing obligations of a credit provider or lessor (either as the credit provider or lessor or on behalf of another person who is the credit provider or lessor), suggesting or assisting with a particular credit contract or consumer lease, acting as an intermediary between a credit provider and a consumer (for a credit contract) or between a lessor and a consumer (for a consumer lease).

More about Credit Licensee on ASIC 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
    name
    Type
    string
  • Name
    namePrevious
    Type
    string
  • Name
    abnOrAcn
    Type
    string
  • Name
    numberOfLicensee
    Type
    string
  • Name
    numberOfAFSLicensee
    Type
    string
  • Name
    edrs
    Type
    string
  • Name
    edrsDescription
    Type
    string
  • Name
    authorisations
    Type
    string
  • Name
    address
    Type
    object
    Description
    • Name
      locality
      Type
      string
    • Name
      state
      Type
      string
    • Name
      postcode
      Type
      string
    • Name
      country
      Type
      string
  • Name
    comment
    Type
    string
  • Name
    dateOfStart
    Type
    string
  • Name
    dateOfEnd
    Type
    string
  • Name
    isSuspended
    Type
    boolean
GET/asic/credit/licensee/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: name, namePrevious, abnOrAcn, numberOfLicensee, numberOfAFSLicensee.

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
/asic/credit/licensee/find/
curl "https://api.vigil.sh/asic/credit/licensee/find/?query={query}" \
  -H 'x-api-key: {api-key}'

Response

{
  "results": [
    {
      "id": "zv_aviFNc2ZWh13rwhzGw_Y3mkgW8OYPrA==",
      "name": "TERRA AUSTRALIS PTY. LTD."
      "namePrevious": "UNDISCOVERED"
    },
    // ...
  ],
  "resultsTotal": 4
}
GET/asic/credit/licensee/

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
/asic/credit/licensee/
curl "https://api.vigil.sh/asic/credit/licensee/?id={id}" \
  -H 'x-api-key: {api-key}'

Response

{
  "name": "TERRA AUSTRALIS PTY LTD",
  "namePrevious": "UNDISCOVERED",
  "abnOrAcn": "12345678901",
  "numberOfLicensee": "123456",
  "edrs": "AFCA",
  "edrsDescription": "Australian Financial Complaints Authority",
  "authorisations": "This licence authorises the licensee to: Engage in credit activities as a credit provider by: carrying on a business of providing credit being credit the provision of which the National Credit Code applies to; and/or being a credit provider under a credit contract; and/or performing the obligations or exercising the rights of a credit provider in relation to a credit contract or proposed credit contract as the credit provider; and/or providing credit assistance to a consumer which relates to a credit contract or proposed credit contract under which the licensee is or will be the credit provider; and/or being a mortgagee under a mortgage that secures or will secure obligations under a credit contract under which the licensee is the credit provider; and/or performing the obligations or exercising the rights of a mortgagee in relation to a mortgage or proposed mortgage which secures or will secure obligations under a credit contract under which the licensee is the credit provider; and/or being a beneficiary under a guarantee that guarantees obligations under a credit contract under which the licensee is the credit provider; and/or performing the obligations or exercising the rights of a beneficiary under a guarantee or proposed guarantee which guarantees obligations under a credit contract under which the licensee is the credit provider; and/or carrying on a business of providing consumer leases; and/or being a lessor under a consumer lease; and/or providing credit assistance to a consumer in relation to a consumer lease or proposed consumer lease for which the licensee is the lessor; and/or performing the obligations or exercising the rights of a lessor in relation to the consumer lease as the lessor",
  "address": {
    "locality": "SYDNEY",
    "state": "NSW",
    "postcode": "2000",
    "country": "Australia"
  },
  "dateOfStart": "01/01/2000"
}