There are 3 Business related functions in the Frankie Financial API:
- The Business Ownership Query
- The Check Organisation Query
- Run a Credit Report or Credit Score Report
The Business Ownership Query will take an ACN or ABN, and then proceed to query government databases to ascertain:
- Name and corporate details of the company
- Office bearers, shareholders and ultimate beneficial owners (where possible)
- Corporate structure
- It can also optionally perform KYC and AML checks on any/all of the above.
You can provide and entity with just an ACN or ABN to run this query, or you can alternatively provide both and an optional company type (as per the ABR list of entity types) and company name. The query will also validate those supplied details to see if they match what you may already have on record. The service will stop should any material difference be found.
You can also use this query to just pull back the ASIC data with no further checks or corporate structure traversals if all you want is just the details of the company in question.
You do this by setting the
onlyProfile flag to true in the request.
HTTP POST /business/ownership/query?onlyProfile=true
See Defining an ORGANISATION entity object on how to create a simple organisation entity for querying.
The Check Organisation Query will just perform the KYC/AML checks on any/all known Office bearers, shareholders and beneficial owners. It assumes that a previous Business Ownership Query had previously been run. If not, an error will be returned.
Currently available reports (as at 2020-11-03) are:
creditScorewhich will give a current credit score along with the past year's worth of scores (if available)
creditReportwhich will return lists of the following data about the requested company:
- Insolvency notices
- Payment defaults
- Mercantile enquiries
- Court judgements
- Loans (where permitted)
These are called via the Run Report(s) API function
You can request one or more of the above reports at the same time by setting the reportTypes parameter using a comma separated list:
HTTP POST /business/report/query?reportTypes=creditReport,creditScore
Updated 10 months ago