Skip to main content
GET
/
business
/
{entityId}
/
list
(International) List available documents in catalogue
curl --request GET \
  --url https://api.uat.frankie.one/compliance/v1.2/business/{entityId}/list \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reports": [
    {
      "availableFormats": "PDF",
      "priceTierCode": "A",
      "provider": "kyckr",
      "reportCode": "ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ=",
      "reportTitle": "Current and Historical Company Information"
    }
  ],
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
}

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.

Path Parameters

​
entityId
string<uuid>
required

The entityId of a business entity returned by a successful call to /business/international/profile

Response

List of documents available for order for this entity.

List of reports available for order

​
entityId
string<uuid>

The ID of the entity the list of reports belongs to.

​
reports
object[]

The collection of the available reports.

​
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"