Skip to main content
GET
/
business
/
{entityId}
/
report
(International) Get status of document order
curl --request GET \
  --url https://api.uat.frankie.one/compliance/v1.2/business/{entityId}/report \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "lastFetchRun": "0001-01-01 00:00:00 +0000 UTC",
  "nextFetchRun": "0001-01-01 00:00:00 +0000 UTC",
  "reportCode": "ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ=",
  "reportStatus": "Waiting on Provider",
  "reportTitle": "provider-reportCode",
  "reportUrl": "https://api.frankie.one:433/compliance/v1.2/document/7d365381-bc12-89da-3681-dafc72112dgt/full?scanDocId=7d365381-bc12-89da-3681-dafc7211sfgh",
  "requestId": "01G12MZZXKCXN8G6EWK1D4RGA8",
  "requestedDate": "0001-01-01 00:00:00 +0000 UTC",
  "documentOrders": {
    "lastFetchRun": "0001-01-01 00:00:00 +0000 UTC",
    "nextFetchRun": "0001-01-01 00:00:00 +0000 UTC",
    "reportCode": "ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ=",
    "reportStatus": "Waiting on Provider",
    "reportTitle": "provider-reportCode",
    "reportUrl": "https://api.frankie.one:433/compliance/v1.2/document/7d365381-bc12-89da-3681-dafc72112dgt/full?scanDocId=7d365381-bc12-89da-3681-dafc7211sfgh",
    "requestId": "01G12MZZXKCXN8G6EWK1D4RGA8",
    "requestedDate": "0001-01-01 00:00:00 +0000 UTC"
  }
}

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

Query Parameters

​
requestId
string<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.

Details of the report order status

​
lastFetchRun
string

time of last fetch run

Example:

"0001-01-01 00:00:00 +0000 UTC"

​
nextFetchRun
string

time of next fetch run

Example:

"0001-01-01 00:00:00 +0000 UTC"

​
reportCode
string

product code with which to order the report

Example:

"ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ="

​
reportStatus
string

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

Example:

"Waiting on Provider"

​
reportTitle
string

title of the final report (optional)

Example:

"provider-reportCode"

​
reportUrl
string

url of the final report (optional)

Example:

"https://api.frankie.one:433/compliance/v1.2/document/7d365381-bc12-89da-3681-dafc72112dgt/full?scanDocId=7d365381-bc12-89da-3681-dafc7211sfgh"

​
requestId
string

request Id

Example:

"01G12MZZXKCXN8G6EWK1D4RGA8"

​
requestedDate
string

date when order was requested

Example:

"0001-01-01 00:00:00 +0000 UTC"

​
documentOrders
object

Details of the report order status