Generate an Individual Verification Report for an entity. The report contains all the latest personal information and the check results ran on the entity.
You can generate the report in two ways:
Asynchronous: You receive a requestID in the response. Once the PDF is generated, a notification will be sent to your web-hook endpoint. The notification includes a downloadable URL. More info on the web-hook set up here: https://docs.frankieone.com/docs/notifications-webhooks.
Synchronous: Once the PDF is generated, you will receive a downloadable link in the response.
Please note, the link expires after a configurable time. Either way, the generated report is also attached to the entity as a document object under idType “kyc-report”. The scanData is a base64 encoded blob.
The entityId returned previously from an earlier call to /check or /entity
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.
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.
Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are:
Any alphanumeric string is supported though. Anything over 64 characters will be truncated.
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See out callback API for details on this.
See more details here: https://docs.frankieone.com/docs/asynchronous-calls-backgrounding-processes
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.
The document id where the report is saved in the entity.
The entityId that this report was generated from.
Timestamp when the link expires.
Downloadable link to the report.
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.
The doc scan id where the report is saved in the document.