Trigger the Generation of a KYC Entity Report

(ALPHA): This endpoint is in alpha.

Generate a PDF certification 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://apidocs.frankiefinancial.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 PDF report is also attached to the entity as a document object under idType “kyc-report”. The scanData is a base64 encoded blob.

Language
Authentication
Header
Click Try It! to start a request and see the response here!