Generate Sample Report

post

https://sandbox.treeforttech.com/api/test/generate-idv-response

This endpoint is used to simulate a Treefort report for testing or demo purposes. Using this endpoint will generate a sample report with test data for the clientRequestId used in the request, and will also send a response to your webhook (if configured).

Note: this endpoint is only available in the sandbox (UAT) environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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	Bool	A true or false value indicating if the sample report was successfully generated.
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.

Body Params

clientRequestId

string

required

The unique reference ID (clientRequestId) 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.

criteria

string

required

Use the criteria object to simulate various sample report scenarios for testing or demo purposes. See the request example for the available parameters. Note: please see below for notes on specific parameters.

id: for this parameter, "string" can be used for sessionId, mediaId01, and mediaId02 to avoid errors. For the recommendationValue parameter, use APPROVE or REJECT. If REJECT is used for the recommendationValue, use one of the following options for the recommendationReason parameter to simulate a fail: DOCUMENT_COPY or COUNTERFEIT.

facialVerification: for this parameter, "string" can be used for token to avoid errors.

Responses

Response Schema

200200

400400