post
https://sandbox.treeforttech.com/api/client/report-download-link
This endpoint is used to generate a link to a client's ID verification report, providing a method for end users to download a client's ID verification report (in English or French) without any report data sent directly to your servers. This link is password protected and the password is set at the time of generating the link.
To change any link parameters (e.g., recipients, link expiration, password, etc.) or if a previous link expired and a new link needs to be generated, call the endpoint again to expire the previous link (if not already expired) and generate a new link with the updated parameters.
To return the Treefort report directly to your servers for storage or further processing, use the Verification Report endpoint instead.
Response Schema
| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Standard HTTP response code. Status codes are outlined in the Errors section of this API reference. |
| message | String | A human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference. |
| data.clientRequestId | String | The unique reference ID created by Treefort and passed back in response from the Create Verification Request or Update Verification Request endpoint for each client, and passed back via webhook response when a report is ready for review. This ID is used to track the ID verification request associated with only this client, and can be provided to Treefort for troubleshooting purposes. |
| data.reportNumber | String | The unique report number associated with this Treefort report. This string can also be found in the top right corner of a Treefort report. |
| data.reportDate | String | The date when the Treefort report was completed and available for download. This will be the date found in the top right corner of a Treefort report. The format of the timestamp is as follows: YYYY-MM-DDTHH:MM:SS (e.g., 2025-08-05T20:05:51). |
| data.reportExpiryDate | String | The date when the report will expire and will no longer be available to retrieve using this endpoint. This date is based on the expiration date of the ID document that the client used in the ID verification process. The format of the timestamp is as follows: YYYY-MM-DDTHH:MM:SS (e.g., 2025-08-05T20:05:51). If the ID document expires less than 3 months from the time of the ID verification report date, then the expiration date will be 3 months from the report date. If the ID document expires greater than 1 year from the time of the ID verification report date, then the expiration date will be 1 year from the report date. If the ID document expires greater than 3 months from the time of the ID verification report date but less than 1 year from the time of the ID verification report date, then the expiration date will be the same as the expiration date on the client's ID document. |
| data.linkExpiration | String | Returns the timestamp for when the link(s) to the client's ID verification report returned from this endpoint will expire. If the link is expired, anyone with access to the link will no longer be able to download the client's ID verification report using the existing link. If a new link is required, call this endpoint again. The format of the timestamp is as follows: YYYY-MM-DDTHH:MM:SS (e.g., 2025-08-05T20:05:51). All timestamps are in UTC. If no linkExpiration was provided in the request, the link expiration will default to the Report Expiration Date (i.e., the report expiration date on the final Treefort report - min 3 months, max 1 year). This is the date when the report will expire and will no longer be available to retrieve from the system. This date is based on the expiration date of the ID document that the client used in the ID verification process. If a linkExpiration date was provided in the request that is greater than the Report Expiration Date, the Report Expiration Date will be used as the link expiration date. In other words, the linkExpiration would always be the lowest of Report Expiration Date and linkExpiration provided in the request. For example, if the Report Expiration Date is 2025-07-20T23:59:59 and 2025-08-01T00:00:00 is passed in as the linkExpiration date, the link expiration date will be 2025-07-20T23:59:59. If the Report Expiration Date is 2025-07-20T23:59:59 and 2025-06-01T00:00:00 is passed in as the linkExpiration date, the link expiration date will be 2025-06-01T00:00:00. |
| data.notificationMethod | Integer | Returns the notification method that was used in the request. 1 will indicate that an email with a secure link to download the client's ID verification report was sent to the recipient(s). 0 will indicate that no email was sent to recipients with the link to the client's ID verification report. If 0 is used, an alternative method must be used to provide any users with the download link to the client's ID verification report (e.g., custom email, embedded link, etc.). |
| data.linkDetails | Array of Objects | An object is returned for each recipient that was used in the request. Each object will return the following: link: provides the link for that recipient to review and download the ID verification report. recipient: returns the email address of the recipient, if applicable. If no recipients were used in the request, only one link will be provided and the recipient will be marked as null. |
| errors | Array of Strings | An array of human-readable error messages, if available (null otherwise). |