Skip to main content
GET
/
business
/
{entityId}
/
checks
(AUS Only) Retrieve previous UBO query results
curl --request GET \
  --url https://api.uat.frankie.one/compliance/v1.2/business/{entityId}/checks \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "flags": "kyb_target",
  "organisationCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationCheckResult": {
    "entityCategories": {},
    "entityCheckErrors": {},
    "entityCheckResults": {},
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "ownershipCheckDate": "2023-11-07T05:31:56Z",
  "ownershipCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ownershipQueryError": {
    "errorCode": "CORE-5990",
    "errorMsg": "Everything went kaflooey. Stay clam.",
    "requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
    "commit": "2af478ed",
    "httpStatusCode": 501,
    "issues": [
      {
        "issueLocation": "dateOfBirth",
        "issue": "Invalid format. Must be YYYY-MM-DD"
      }
    ]
  },
  "ownershipQueryResult": {
    "associatedEntities": {},
    "blockingEntityDetails": {},
    "blockingEntityIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "entityCreatedDate": "2023-11-07T05:31:56Z",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityUpdatedDate": "2023-11-07T05:31:56Z",
    "otherOwners": {},
    "ownershipDetails": {},
    "ownershipPolicy": {
      "blockingDefinitions": [
        "<string>"
      ],
      "blockingThreshold": 123,
      "uboThreshold": 123
    },
    "uncategorisedEntities": {}
  },
  "reportError": {
    "errorCode": "CORE-5990",
    "errorMsg": "Everything went kaflooey. Stay clam.",
    "requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
    "commit": "2af478ed",
    "httpStatusCode": 501,
    "issues": [
      {
        "issueLocation": "dateOfBirth",
        "issue": "Invalid format. Must be YYYY-MM-DD"
      }
    ]
  },
  "reportResult": {
    "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "location": "<string>",
    "scanDocId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
  "uboResponse": {
    "supplied_data": {
      "abn": 99001234321,
      "acn": 342225,
      "company_type": "PRV",
      "customer_reference": "WBC000ABC123",
      "name": "Worldwide Widget Pty. Ltd."
    },
    "asic_search_timestamp": "2016-08-29T09:12:33.001Z",
    "business_details": {
      "ABN": "<string>",
      "ACN": "<string>",
      "ARBN": "<string>",
      "anzsic_code": "<string>",
      "giin": "<string>",
      "registered_name": "<string>",
      "asic_company_type": "<string>",
      "business_names": [
        "<string>"
      ],
      "date_registered_with_asic": "2023-12-25",
      "entity_id": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
      "place_of_business": {
        "country": "AUS",
        "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
        "addressType": "REGISTERED_OFFICE",
        "buildingName": "Highland Tower",
        "careOf": "<string>",
        "endDate": "0001-01-01",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
        "postalCode": "3000",
        "region": "MELBOURNE",
        "startDate": "2023-03-10",
        "state": "VIC",
        "streetName": "9 ROYCE AVENUE",
        "streetNumber": "FLAT 27",
        "streetType": "Road",
        "suburb": "Testburb",
        "town": "MELBOURNE",
        "unitNumber": "FLAT 27",
        "unstructuredLongForm": "<string>"
      },
      "public_company": true,
      "registered_office": {
        "country": "AUS",
        "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
        "addressType": "REGISTERED_OFFICE",
        "buildingName": "Highland Tower",
        "careOf": "<string>",
        "endDate": "0001-01-01",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
        "postalCode": "3000",
        "region": "MELBOURNE",
        "startDate": "2023-03-10",
        "state": "VIC",
        "streetName": "9 ROYCE AVENUE",
        "streetNumber": "FLAT 27",
        "streetType": "Road",
        "suburb": "Testburb",
        "town": "MELBOURNE",
        "unitNumber": "FLAT 27",
        "unstructuredLongForm": "<string>"
      },
      "regulatory_information": {
        "licence_details": "<string>",
        "licence_number": "<string>",
        "licence_verified": true,
        "regulatory_body": "<string>"
      },
      "state_registered_with_asic": "<string>",
      "stock_exchange_data": {
        "approved_exchange": true,
        "exchange": "<string>",
        "exchange_ticker": "<string>",
        "supporting_document_links": [
          "<string>"
        ],
        "supporting_evidence_in_pdf": true
      },
      "trading_names": [
        "<string>"
      ]
    },
    "business_screening_result": {
      "aml_result": {
        "check_result": "NOT_SCREENED",
        "media_hit_count": 0
      },
      "kyc_result": {
        "address_match_count": 1,
        "dob_match_count": 1,
        "name_match_count": 2,
        "check_result": "PASS",
        "matching_sources": [
          "au-elec",
          "ntd",
          "dvs"
        ]
      }
    },
    "error_message": "<string>",
    "issues_list": [
      {
        "issue_description": "Date of birth not found",
        "issue_location": "ultimate_beneficial_owner.0.date_of_birth",
        "issue_severity": "INFO"
      }
    ],
    "non_individual_beneficial_owners": [
      {
        "beneficially_held": true,
        "percent_owned": 123,
        "entity_type": "APUB",
        "name": "Widget Trust Corpoation Inc.",
        "stock_exchange_data": {
          "approved_exchange": true,
          "exchange": "<string>",
          "exchange_ticker": "<string>",
          "supporting_document_links": [
            "<string>"
          ],
          "supporting_evidence_in_pdf": true
        }
      }
    ],
    "officeholders": [
      {
        "beneficially_held": true,
        "percent_owned": 123,
        "role": "Director",
        "addresses": [
          {
            "country": "AUS",
            "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
            "addressType": "REGISTERED_OFFICE",
            "buildingName": "Highland Tower",
            "careOf": "<string>",
            "endDate": "0001-01-01",
            "extraData": [
              {
                "kvpKey": "ACN",
                "kvpType": "id.external",
                "kvpValue": "406655338"
              }
            ],
            "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
            "postalCode": "3000",
            "region": "MELBOURNE",
            "startDate": "2023-03-10",
            "state": "VIC",
            "streetName": "9 ROYCE AVENUE",
            "streetNumber": "FLAT 27",
            "streetType": "Road",
            "suburb": "Testburb",
            "town": "MELBOURNE",
            "unitNumber": "FLAT 27",
            "unstructuredLongForm": "<string>"
          }
        ],
        "date_of_birth": "1969-01-01",
        "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "JAN MICHAEL VINCENT",
        "screening_result": {
          "aml_result": {
            "check_result": "NOT_SCREENED",
            "media_hit_count": 0
          },
          "kyc_result": {
            "address_match_count": 1,
            "dob_match_count": 1,
            "name_match_count": 2,
            "check_result": "PASS",
            "matching_sources": [
              "au-elec",
              "ntd",
              "dvs"
            ]
          }
        }
      }
    ],
    "supplied_data_matches": {
      "matched_acn": true,
      "matched_company_type": true,
      "matched_name": true
    },
    "ultimate_beneficial_owners": [
      {
        "beneficially_held": true,
        "percent_owned": 123,
        "role": "Director",
        "addresses": [
          {
            "country": "AUS",
            "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
            "addressType": "REGISTERED_OFFICE",
            "buildingName": "Highland Tower",
            "careOf": "<string>",
            "endDate": "0001-01-01",
            "extraData": [
              {
                "kvpKey": "ACN",
                "kvpType": "id.external",
                "kvpValue": "406655338"
              }
            ],
            "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
            "postalCode": "3000",
            "region": "MELBOURNE",
            "startDate": "2023-03-10",
            "state": "VIC",
            "streetName": "9 ROYCE AVENUE",
            "streetNumber": "FLAT 27",
            "streetType": "Road",
            "suburb": "Testburb",
            "town": "MELBOURNE",
            "unitNumber": "FLAT 27",
            "unstructuredLongForm": "<string>"
          }
        ],
        "date_of_birth": "1969-01-01",
        "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "JAN MICHAEL VINCENT",
        "screening_result": {
          "aml_result": {
            "check_result": "NOT_SCREENED",
            "media_hit_count": 0
          },
          "kyc_result": {
            "address_match_count": 1,
            "dob_match_count": 1,
            "name_match_count": 2,
            "check_result": "PASS",
            "matching_sources": [
              "au-elec",
              "ntd",
              "dvs"
            ]
          }
        }
      }
    ]
  }
}

Authorizations

​
api_key
string
header
required

API key issued by Frankie Financial. This will rotate regularly.

Headers

​
X-Frankie-CustomerID
string<uuid>
required

Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.

​
X-Frankie-CustomerChildID
string<uuid>

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.

Note: If using a CustomerChildID, you will also need a separate api_key for each child.

Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.

A Customer can see the documents/entities and checks of all their Children.

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are:

  • api
  • portal
  • smartui

Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Path Parameters

​
entityId
string<uuid>
required

The entityId returned previously from an earlier call to /check or /entity

Query Parameters

​
documentData
enum<string>
default:full

The type of document data to return - with document scans or not. Default is 'full'.

Available options:
meta,
full

Response

This is what you will find in the payload of a retrieved response should the ownership query succeed, or you're querying the past checks for a given business.

NOTE: When requesting the initial report, you will only ever receive a 202 response.

The result of an /business/ownership/query call retrieved via GET /retrieve/response/{requestId} after you receive a notification that the result is ready.

​
flags
object[]

Used to set additional information flags for this response.

Example:

"kyb_target"

​
organisationCheckId
string<uuid>

Batch identifier for the KYC/AML check results if any.

​
organisationCheckResult
object

The results of KYC/AML check on a organisation with a prior ownership query. This will be retrived via GET /retrieve/response/{requestId} after you receive a notification that the results are ready.

​
ownershipCheckDate
string<date-time>

If an ownership result is provided in this response then this is the date and time the service provided that result.

​
ownershipCheckId
string<uuid>

Unique identifier for the ownership check.

​
ownershipQueryError
object
​
ownershipQueryResult
object
​
reportError
object
​
reportResult
object

The positive result of a report generation request if any.

​
requestId
string<ulid>

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Example:

"01BFJA617JMJXEW6G7TDDXNSHX"

​
uboResponse
object