File Details

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.requesterReferenceId	String	The unique reference ID created by your organization and passed into the endpoint is returned. This ID is used to track all ID verifications associated with this request (i.e. all ID verifications associated to a file).
data.fileReferenceId	String	The unique reference ID created by treefort for internal purposes. This ID is used to track all ID verifications associated with this request (i.e. all ID verifications associated to a file), and can be provided to treefort for troubleshooting purposes.
data.fileName	String	The file name created by your organization or automatically created by treefort.
data.fileNumber	String	The unique file number created by your organization or automatically created by treefort.
data.fileStatus	String	The current file status. Possible values: In Progress: when there is no client ID verification associated with the requesterReferenceId (i.e. file) with “Review Report” as the requestStatus, and the file has not been Cancelled or Closed. Action Required: when there is a client ID verification associated with the requesterReferenceId (i.e. file) with “Review Report” as the requestStatus, and the file has not been Cancelled or Closed. Cancelled: when this file has been cancelled using the Cancel File endpoint. Closed: when this file has been closed using the Close File endpoint.
data.transactionKey	String	The Transaction Key is unique to each file containing 1 or more ID verifications and may be requested by a third-party (e.g., title insurance companies) for the purposes of reviewing the ID verification reports associated with each transaction (file).
data.requests	Array of Objects	The client profile that is associated with this request. Each client profile returned has received the request to go through the ID verification process. The individual attributes associated with each object are outlined below for the first array element.
data.requests[0].clientRequestId	String	The 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. This ID will also be required as an input for other API endpoints relating to this client.
data.requests[0].requesterClientRequestId	String	The unique reference ID created by your organization is returned. This ID is used to track the ID verification associated with only this client.
data.requests[0].email	String	The email address associated with the client in this client profile.
data.requests[0].requestStatus	String	The current client verification status. All possible client verification statuses are detailed in the Verification Status endpoint in this API reference.
data.requests[0].report	Null	Will always return null. Please use the Verification Report endpoint to retrieve the base64 encoded PDF of the ID verification report associated with this client.
data.requests[0].verificationReportExpiryDate	String	The 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.requests[0].verificationReportExpiryWarningDate	String	Depending 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.
data.requests[0].links	Array of Objects	An array of links that are associated with the client's ID verification (i.e. clientRequestId). Each link sent to the client is outlined here, and includes when the link was sent and the link's expiry date. The individual attributes associated with each object are outlined below for the first array element.
data.requests[0].links[0].id	Integer	A unique ID created by TreeFort and used to track a particular link. This can be provided to TreeFort for troubleshooting purposes.
data.requests[0].links[0].startDate	String	The date the link was sent to the client, in the following format: 2021-03-24T12:00:00.
data.requests[0].links[0].endDate	String	The date the link that was sent to the client will expire, in the following format: 2021-03-27T12:00:00. Note: links for ID verification requests will typically expire 3 days after the request has been sent to a client, unless the request was cancelled prior using the Cancel Verification endpoint. If the client does not complete the process within 3 days, the process must be re-initiated using the Re-Initiate Verification endpoint.
data.requests[0].firstName	String	The first name of the client associated with this clientRequestId.
data.requests[0].lastName	String	The last name of the client associated with this clientRequestId.
errors	Array of Strings	An 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.