Configure response

AI Tools

Instead of relying on the Yoti default sandbox response, integrators can configure which checks pass or fail and specify the failure reasons within a session. This is done using an object that includes defined task_results and check_reports.

Endpoint

HTTP
    
 
https://api.yoti.com/sandbox/idverify/v1/sessions/{sessionId}/response-config
Copy

Code examples

Javascript
PHP
Python
Java
Go
    
​x
 
const { RequestBuilder, Payload } = require("yoti");​const request = new RequestBuilder()  .withBaseUrl("https://api.yoti.com/sandbox/idverify/v1")  .withPemFilePath("<YOTI_KEY_FILE_PATH>")  .withEndpoint("/sessions/<SESSION_ID>/response-config")  .withPayload(new Payload(RESPONSE_CONFIG))   .withMethod("PUT")  .withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")  .build();​//get Yoti responseconst response = request.execute();
Copy

Example Response Configuration

JSON
    
 
{    "task_results": {        "ID_DOCUMENT_TEXT_DATA_EXTRACTION": [            {                "result_template": "SUCCESS"            }        ]    },    "check_reports": {        "ID_DOCUMENT_AUTHENTICITY": [            {                "result": {                    "report_template": "SUCCESS"                }            }        ],        "ID_DOCUMENT_FACE_MATCH": [            {                "result": {                    "report_template": "SUCCESS"                }            }        ],        "LIVENESS": [            {                "liveness_type": "STATIC",                "response_delay": 5,                "result": {                    "report_template": "SUCCESS"                }            }        ]    }}
Copy

On completion of this API request, you will simply receive a 200 response.

In the sandbox you can configure both successful outcomes of checks and unsuccessful outcomes of checks to mock multiple different scenarios. The below table outlines the different scenarios that can be mocked.

Check	Report template	Description
ID_DOCUMENT_AUTHENTICITY	SUCCESS	This simulates a "APPROVE" outcome for the document authenticity check
ID_DOCUMENT_AUTHENTICITY	TAMPERED	This simulates a "REJECT" outcome for the document authenticity check, due to a fraudulent document.
ID_DOCUMENT_AUTHENTICITY	DOCUMENT_COPY	This simulates a "REJECT" outcome for the document authenticity check, due to an image of a document being used instead of a live capture.
ID_DOCUMENT_AUTHENTICITY	PHOTO_TOO_BLURRY	This simulates a "NOT_AVAILABLE" outcome for the document authenticity check, due a blurry image.
ID_DOCUMENT_AUTHENTICITY	FRAUD_LIST_MATCH	This simulates a "REJECT" outcome for the document authenticity check, due to a fraudulent document.
ID_DOCUMENT_AUTHENTICITY	GLARE_OBSTRUCTION	This simulates a "NOT_AVAILABLE" outcome for the document authenticity check, due to glare obstruction.
ID_DOCUMENT___FACE_MATCH	SUCCESS	This simulates a "APPROVE" outcome for the face match check.
ID_DOCUMENT_FACE_MATCH	AUTO_FAIL	This simulates a "REJECT" outcome for the face match check. With the automated sub check failing.
ID_DOCUMENT_FACE_MATCH	MANUAL_FAIL	This simulates a "REJECT" outcome for the face match check. With the manual sub check failing.
ID_DOCUMENT_FACE_MATCH	FAIL	This simulates a "REJECT" outcome for the face match check. With both the automated and the manual sub check failing.
ID_DOCUMENT_TEXT_DATA_EXTRACTION	SUCCESS	This simulates a "APPROVE" outcome for the data extraction.
ID_DOCUMENT_TEXT_DATA_EXTRACTION	EXTRACTION_FAILED	This simulates a "REJECT" outcome for the data extraction.
LIVENESS	SUCCESS	This simulates a "APPROVE" outcome for the liveness check.
LIVENESS	FAIL	This simulates a "REJECT" outcome for the liveness check.

IDV Sandbox guide - General sandbox setup
Understanding the results - Results structure and interpretation
Example code - Advanced scenarios

Last updated on

Was this page helpful?

Configure response

Endpoint

Code examples

Example Response Configuration

Related resources