Verification 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.clientRequestId	String	The unique reference ID associated to this client's ID verification request, as passed into this endpoint. 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.requestStatus	String	The status of this client's ID verification. Possible values: Request Pending: The ID verification request has been sent to the client, but the client has not yet completed the process. Cancelled: The ID verification request has been cancelled. To re-initiate the request to this client, use the Re-initiate Verification endpoint. Review Report: The ID verification process has been completed by the client and there is a report ready for review. Use the Verification Report endpoint to retrieve the report for this verification request.
data.profile.firstName	String	The first name of the client associated with this clientRequestId.
data.profile.middleName	String	The middle name of the client associated with this clientRequestId, if available.
data.profile.lastName	String	The last name of the client associated with this clientRequestId.
data.profile.email	String	The email address of the client associated with this clientRequestId.
data.profile.phoneNumber	String	The cell phone number of the client associated with this clientRequestId.
data.profile.dateOfBirth	String	The date of birth of the client associated with this clientRequestId. Note: the client's date of birth will be read from their government-issued photo ID and will be returned as 0001-01-01T00:00:00 if they have not yet completed the ID verification process.
data.profile.address	String	The concatenated address information of the client associated with this clientRequestId.
data.profile.city	String	The city of the client associated with this clientRequestId.
data.profile.province	String	The province of the client associated with this clientRequestId.
data.profile.country	String	The country of the client associated with this clientRequestId.
data.profile.postalCode	String	The postal code of the client associated with this clientRequestId.
data.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.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.links[0].startDate	String	The date the link was sent to the client, in the following format: 2021-03-24T12:00:00.
data.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.requesterClientRequestId		The unique reference ID created by your organization is returned. This ID is used to track the ID verification associated with only this client.
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.