Skip to main content
POST
/
business
/
{entityId}
/
report
(International) Order document from catalogue
curl --request POST \
  --url https://api.uat.frankie.one/compliance/v1.2/business/{entityId}/report \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "provider": "kyckr",
  "reportCode": "ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ=",
  "reportFormat": "PDF"
}
'
{
  "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

Body

application/json

Details required to order the document. The reportCode should come from the catalogue request.

Details of the report to be ordered

​
provider
string

The name of the service provider from which to order the report.

Example:

"kyckr"

​
reportCode
string

product code with which to order the report. This should come from the reportCode returned in the BusinessReportCatalogue endpoint

Example:

"ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ="

​
reportFormat
string

report format (optional). eg: html, pdf

Example:

"PDF"

Response

The request was valid and can potentially be fulfilled. The Frankie service has now accepted responsibility for processing and we will either push the results to you, or send you a notification, depending on the request and your configuration.

The following fields represent the data you need in order to retrieve the results of the requested function.

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