Order a document from Catalogue

Order a specific report based on the available reports for an organisation in a country

Suggest Edits

You can now request a specific registry document from the available list of reports returned via the Reports List endpoint.

Use the report code and the entityID from the previous steps to request a specific report. Once the report is requested you will be notified via the push notification as to when the report is ready to be used.

Request a specific report from the available list using the /business/{{entityId}}/report endpoint.

  1. In the example above, replace YOUR_CUSTOMER_ID with your Customer ID and YOUR_API_Key with your API key provided by FrankieOne.
  2. You need to also replace the "entityId" in the URL param with the entity ID of the business that you need the reports for
  3. You need to also replace the Replace "REPORT_CODE_FROM_PREVIOUS_STEP" with the report code of the report that you would like to place the request for.

Request

curl --request POST \
     --url https://api.demo.frankiefinancial.io/compliance/v1.2/business/entityid/report \
     --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \
     --header 'api_key: YOUR_API_KEY'
     --header 'content-type: application/json' \
     --data '{
       "reportCode": "REPORT_CODE_FROM_PREVIOUS_STEP",
     }'

Response

The response will contain a response code if the report has been requested successfully

{
    "requestId": "01G17VFCZAPPMEAFHWSC8ZENNJ"
}

👍

What is the requestId used for?

The requestID returned above is required for retrieving the status of the order.

The report code signifies a specific report on the Provider end.

Retrieving the report

📘

Background Processing

The Ordering a Report endpoint always completes asynchronously, regardless of whether the X-Frankie-Background header is included in the request.

The fetching of the report is performed in the background and the result will be returned asynchronously. How long this takes depends on a number of factors:

  • The time it takes for Provider's end to make the report available
  • The number of requests in the system at a specific point in time

More information - Retrieving a Requested Report

📘

Background Processing

The report is fetched in the background via a polling service and a push notification is sent once the report is ready to be downloaded

Updated 8 days ago