Update Verification Request

POST https://sandbox.treeforttech.com/api/verification/update

This endpoint is used to update an existing ID verification request to one or more clients, and can be used to:

1. Associate new clients with an existing file (i.e. fileReferenceId).

2. Update client information that will be used in the ID verification process (e.g. update a client's email or phone number).

Note: if attempting to apply different settings to a client's verification request (e.g., banking login enabled/disabled, etc.), use the Re-Initiate Verification endpoint.

Note: if the client already has a pending ID verification request outstanding on this file or if the client has already completed the ID verification process and has a report available for review, updating their information will cancel the client's existing ID verification link and the client will receive a new link with the updated information.

Note: a new clientRequestId will be created and passed back for the updated verification request, and the previous clientRequestId will be marked as "Cancelled".

Tips on associating new clients with an existing file

If you are an integrator sending requests on behalf of multiple separate organizations (e.g., multiple law firms, brokerages, etc.) you will likely want to set the createNewClientRecord parameter to true for all requests so that a new client record is created in our system if a client already exists in varying statuses (pending, cancelled, review report, etc.) within the same or different files. This will ensure that the status of a client that already exists within or between separate organizations will not impact a subsequent request to the same client. A client exists if the email address has previously been used. This parameter can be used to support the following use cases:

• the same email address can be used multiple times within the same file (e.g., if two individuals wanted to use the same email address but needed to complete separate IDVs). Since multiple unique client records would be created, each IDV request can be sent with different settings, and each client can complete their own report using the same email address.


• the same email address can be used multiple times at the same time between different files (e.g., if Law Firm A and Law Firm B both requested independent reports for a client at the same time).

If the createNewClientRecord parameter is not used or set to false, the following logic would apply:

• if the client does not have a pending ID verification or an active existing ID verification report (i.e., this is a new client or the client's status is REQUEST NOT SENT or CANCELLED), then this endpoint will associate the client to the file and will automatically send a new request to the client.


• if the client already has a pending ID verification (i.e., the client's status is REQUEST PENDING), then this endpoint will associate the client to the file but will not send a new request to the client because an active request already exists. If the link needs to be resent to the client, use the Resend Link endpoint.


• if the client has an active existing ID verification report (i.e., the client's status is REVIEW REPORT, VERIFIED, or REJECTED), then this endpoint will associate the client to the file but will not send a new request to the client because an active report already exists for this client. To initiate a new ID verification request, use the Re-Initiate Verification endpoint.

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 reference ID created by your organization and passed into the endpoint is returned.
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. All possible file statuses are detailed in the File Details endpoint in this API reference. The initial return value will be null.
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	An array of client profiles that are associated with the fileReferenceId. 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 and passed into the endpoint 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 Details endpoint in this API reference. The initial return value will be "Pending", indicating that the ID verification has been sent to the client.
data.requests[0].report	String	A Base64 encoded PDF, if there is an ID verification report available for review for the client associated with the client profile. The initial return value will be null indicating that there is no report available for 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	String	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. Initial return value is null.
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].link	String	The unique link provided for the client to begin and complete the ID verification process. A unique link is provided for each client to complete the ID verification process.
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.