Run Report(s) against a new or existing organisation entity (AUS Only).

v1.0.0

NOTE: Australian companies ONLY. Create or find and update an ORGANISATION type entity, then run the requested reports. Reports include:

Credit Report
Credit Score

At a minimum, you just need to supply an ACN and/or ABN and an entity type set to ORGANISATION. Alternatively the entity ID of an existing ORGANISATION entity gan be given in the request body

Note: these reports are different to the Ultimate Beneficial Owner and Business Detail requests - these reports are independent data and analysis over and above company information and verification details.

You can request multiple reports to be run at once and they will be returned as a group (where feasible).

If a report can only be generated over time, then a temporary response will be returned and a webhook notification will be pushed later once the report has been completed.

Input

{
  "type": "object",
  "properties": {
    "X-Frankie-CustomerChildID": {
      "type": "string"
    },
    "X-Frankie-CustomerID": {
      "type": "string"
    },
    "reportTypes": {
      "type": "string"
    }
  },
  "required": [
    "X-Frankie-CustomerID",
    "reportTypes"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}