(International) Get status of document order | FrankieOne

1 curl https://api.uat.frankie.one/compliance/v1.2/business/entityId/report \ 2 -H "X-Frankie-CustomerID: X-Frankie-CustomerID" \ 3 -H "api_key: <apiKey>"

1 { 2 "documentOrders": { 3 "lastFetchRun": "0001-01-01 00:00:00 +0000 UTC", 4 "nextFetchRun": "0001-01-01 00:00:00 +0000 UTC", 5 "reportCode": "ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ=", 6 "reportStatus": "Waiting on Provider", 7 "reportTitle": "provider-reportCode", 8 "reportUrl": "https://api.frankie.one:433/compliance/v1.2/document/7d365381-bc12-89da-3681-dafc72112dgt/full?scanDocId=7d365381-bc12-89da-3681-dafc7211sfgh", 9 "requestId": "01G12MZZXKCXN8G6EWK1D4RGA8", 10 "requestedDate": "0001-01-01 00:00:00 +0000 UTC" 11 }, 12 "lastFetchRun": "0001-01-01 00:00:00 +0000 UTC", 13 "nextFetchRun": "0001-01-01 00:00:00 +0000 UTC", 14 "reportCode": "ASICON_QVNJQ19Db21wYW55UHJvZmlsZUhpc3RvcmljYWxfRGF0YXN0cmVhbQ==_QVNJQ19DUEhfRFM=_NjAwMDk0OTYwX1ZPREFGT05FIFBUWSBMVEQ=", 15 "reportStatus": "Waiting on Provider", 16 "reportTitle": "provider-reportCode", 17 "reportUrl": "https://api.frankie.one:433/compliance/v1.2/document/7d365381-bc12-89da-3681-dafc72112dgt/full?scanDocId=7d365381-bc12-89da-3681-dafc7211sfgh", 18 "requestId": "01G12MZZXKCXN8G6EWK1D4RGA8", 19 "requestedDate": "0001-01-01 00:00:00 +0000 UTC" 20 }

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.

Authentication

api_keystring

API Key authentication via header

Path parameters

entityIdstringRequiredformat: "uuid"

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

Headers

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.

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

Authentication

Path parameters

Headers

Query parameters

Response

Errors