Financial API EndpointsBusiness

(International) List available documents in catalogue

Lists documents available for order on the entity. This currently only supports entities created through /business/international/profile. (/reference/internationalbusinessprofile)

For further details, see https://docs.frankieone.com/docs/getting-a-list-of-documents

Path parameters

entityIdstringRequiredformat: "uuid"

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

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequiredformat: "uuid"
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-CustomerChildIDstringOptionalformat: "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.

Response

List of documents available for order for this entity.
entityIdstring or nullformat: "uuid"
The ID of the entity the list of reports belongs to.
reportslist of objects or null
The collection of the available reports.
requestIdstring or nullformat: "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.

Errors