Financial API EndpointsBusiness

(International) Get status of document order

Get the status of a previously ordered business report for an entity. To fetch the status and details you just provide the requestID and the entityID. To retrieve all previous orders for an entity, just provide the entityID.

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.

Query parameters

requestIdstringOptionalformat: "ulid"
The requestId that was received when ordering a report. Do not pass this to retrieve all document order statuses for the entity

Response

Status for this business report order is available.
documentOrdersobject or null
Details of the report order status
lastFetchRunstring or null
time of last fetch run
nextFetchRunstring or null
time of next fetch run
reportCodestring or null
product code with which to order the report
reportStatusstring or null

curent status of the report order. eg: Request received, Waiting on Provider

reportTitlestring or null

title of the final report (optional)

reportUrlstring or null

url of the final report (optional)

requestIdstring or null
request Id
requestedDatestring or null
date when order was requested

Errors