Configure Response

AI Tools

Now you that have successfully created a session, the next step is to set the response config. The sandbox requires you to set an expected outcome for your tasks and checks. This will be an object with defined task_results and check_reports. For identity profile sessions, the outcomes that you define for the individual checks will determine the overall outcome for the identity profile check.

Javascript
PHP
Python
Java
Go
C#
    
​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 Config

RTW
DBS
IDENTITY
CUSTOM
    
 
{    "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"                }            }        ],        "THIRD_PARTY_IDENTITY_FRAUD_1": {            "result": {                "report_template": "SUCCESS"            }        }    }}
Copy

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

Last updated on

Was this page helpful?