Verification Report

This endpoint is used to retrieve the verification report for an existing client's ID verification.

Response Schema

AttributeTypeDescription
statusCodeIntegerStandard HTTP response code. Status codes are outlined in the Errors section of this API reference.
messageStringA human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference.
data.clientRequestIdStringThe unique reference ID created by treefort for internal purposes. 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.reportStringA Base64 encoded PDF of the ID verification report for this client.
data.identityAnalysisResultStringThe overall result of the Identity Analysis section of the report. If all KYC methods (government ID, credit file, and dual process) are not satisfied, the value will return as Fail. If at least one KYC method (government ID, credit file, or dual process) is satisfied, the value will return as Pass.
data.fraudAnalysisResultStringThe overall result of the Fraud Analysis section of the report. If at least one High Risk flag is returned, the value will return as Fail, otherwise the value will return as Pass.
data.reportNumberStringThe unique report number associated with this treefort report. This string can also be found in the top right corner of a treefort report.
data.reportDateStringThe date when the report was downloaded using this endpoint or from the treefort portal. This will be the date found in the top right corner of a treefort report.
data.reviewStatusDateStringThe date when the status for this report was set to "Review Report". In other words, the date and time when the client completed the ID verification process and the report was ready for review.
data.verificationReportExpiryDateStringThe date the ID verification report for this client will expire and will no longer be available for download using the Verification Report endpoint, in the following format: 2021-03-29T12:00:00. Depending on your organization's settings, this date will be a maximum of 14 days from the time the ID verification process was completed by the client and a report was returned. If no report is available for this client, the return value will be null.

Note: the report will still be available for download by authorized treefort personnel in the case of audit or troubleshooting purposes.
data.verificationReportExpiryWarningDateStringDepending on your organization's settings, this date will be a specified number of days before the verificationReportExpiryDate (typically 2), indicating that the report will soon be unavailable to retrieve from the Verification Report endpoint.
errorsArray of StringsAn array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code.
Body Params
string
required

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. This ID is used to track the ID verification request associated with only this client, and can be provided to treefort for troubleshooting purposes.

Responses

Language
Credentials
OAuth2
Request
Choose an example:
application/json