Report Meta Data

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.clientInformation.firstName	String	The client's first name as extracted from their government-issued photo ID document used during the ID verification process.
data.clientInformation.middleName	String	The client's middle name as extracted from their government-issued photo ID document used during the ID verification process.
data.clientInformation.lastName	String	The client's last name as extracted from their government-issued photo ID document used during the ID verification process.
data.clientInformation.dateOfBirth	String	The client's date of birth as extracted from their government-issued photo ID document used during the ID verification process.
data.clientInformation.currentAddress.address	String	The client's current address as input into the system by the client during the ID verification process.
data.clientInformation.currentAddress.city	String	The client's current address as input into the system by the client during the ID verification process.
data.clientInformation.currentAddress.province	String	The client's current address as input into the system by the client during the ID verification process.
data.clientInformation.currentAddress.country	String	The client's current address as input into the system by the client during the ID verification process.
data.clientInformation.currentAddress.postalCode	String	The client's current address as input into the system by the client during the ID verification process.
data.clientInformation.currentAddress.countryCode	String	The client's current address as input into the system by the client during the ID verification process.
data.clientInformation.formerAddresses	Array of Objects	An array of former addresses as input into the system by the client during the ID verification process. The following key information will be available for each former address: address city province country postalCode countryCode
data.clientInformation.phoneNumber	String	The client's cell phone number used to initiate the ID verification process.
data.clientInformation.emailAddress	String	The client's email address used to initiate the ID verification process.
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.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.results.identityAnalysisResult	String	The 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.results.complianceGovernmentIdMethod	String	A Pass/Fail indication if this compliance method was satisfied for this client's Treefort report.
data.results.complianceCreditFileMethod	String	A Pass/Fail indication if this compliance method was satisfied for this client's Treefort report.
data.results.complianceDualSourceMethod	String	A Pass/Fail indication if this compliance method was satisfied for this client's Treefort report.
data.results.fraudAnalysisResult	String	The 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.results.identifiedRisks	Array of Objects	An array of individual risk codes that appeared in the Identified Risks section of the Treefort report will be returned. For each risk code returned, the following information will be available: riskLevel: the level of risk assigned to the risk code returned (e.g., High Risk, Notice - Discretion Required, or Not Available). description: the English wording of the risk code as it appears on the English version of the Treefort report. descriptionFr: the French wording of the risk code as it appears on the French version of the Treefort report. shortCode: the human-readable code used to identify this risk code.
data.results.amlResult	String	During the ID verification process, a client’s information will be screened against a consolidated database of global sanction lists, watch lists, and politically exposed persons with thousands of data sources. If any potential matches are found, a "Warning" result will be returned.
data.results.amlUrl	String	If a "Warning" result was returned for the amlResult, a URL will be provided which can be used to review all potential matches returned.
data.results.enhancedRiskAnalysisResult	String	When the banking login is enabled for a client's ID verification and your organization has been approved to receive additional attributes associated with a client's banking login, a Pass/Fail indication will be returned to indicate if the client passed the analysis of the additional attributes. Note: if the banking login has not been enabled for a client's ID verification or if your organization has not been approved to receive the additional attributes, "Not Available" or "Not Enabled" will be returned, respectively, and no attribute information below will be returned.
data.results.enhancedRiskAnalysisFailReason	String	If the enhancedRiskAnalysisResult returned FAIL, the reason(s) for this failure will be returned.
data.results.attributes	Array of Objects	An array of individual banking attributes that appeared in the Enhanced Risk Analysis section of the Treefort report will be returned. For each attribute returned, the following information will be available: attributeName: the description of the attribute. result: the data corresponding to that attribute, as returned from the client's bank account.
data.results.images	Array of Objects	An array of ID document information that the client uploaded during the ID verification process will be returned. For each image uploaded by the client, the following key information will be available: documentType: the type of document uploaded by the client (e.g., PASSPORT, DRIVING_LICENSE, etc.). See the Accepted Document Types reference for a list of accepted document types and the short codes that may be returned. issuingCountry: if available, the issuing country of the ID document in 3166-1 alpha-3 format (e.g., CAN, USA, etc.). isSecondaryId: if clients are required to upload a secondary ID as per your organization settings and the ID uploaded by the client is the client's secondary ID document, this will return true. A maximum of 1 primary and 1 secondary ID document may be uploaded by the client during the ID verification process. Please Note: certain documents (e.g., driver's licenses) require an image of both the front and back of the ID document and therefore 2 objects may be returned for a single ID document uploaded. createDate: the time stamp that the image was uploaded by the client. documentNumber: the document number of the ID document that was uploaded by the client. documentExpiryDate: the expiry date of the ID document that was uploaded by the client. issuingAuthority: the issuing jurisdiction of the ID document uploaded (e.g., issuing province, state, city, etc.)
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 report was returned. This will be the date found in the top right corner of a Treefort report.
data.idvExpiryDate	String	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. Please Note: if the client has a previous ID verification report and this date has passed, it is recommended that the client complete a new ID verification report prior to interacting with this individual. 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.
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.