Financial API EndpointsBusiness

(International) Order document from catalogue

Orders a document relevant to the entity. To discover what documents are available, you should list document catalogue first. On success, will return a 202 response. Frankie systems will poll the provider in the background for the document and attach it to the entity once it is ready, sending you a push notification on completion (if configured).

For further details of this process and document retrieval, see https://docs.frankieone.com/docs/order-a-document

Path parameters

entityIdstringRequired

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

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired
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-CustomerChildIDstringOptional

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.

Request

This endpoint expects an object.
providerstringOptional
The name of the service provider from which to order the report.
reportCodestringOptional
product code with which to order the report. This should come from the reportCode returned in the BusinessReportCatalogue endpoint
reportFormatstringOptional

report format (optional). eg: html, 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.
requestIdstringOptional

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.

Errors