Launch User View

AI Tools

Once you have set your sandbox response config, you will either need to fulfil the user view by launching the Yoti web sdk or bypass the user view by making an API call.. You may continue to render the Yoti web sdk through an iFrame, however the base_url will need to be updated first. The new sandbox iFrame URL is shown below:

HTTP
    
 
https://api.yoti.com/sandbox/idverify/v1/web/index.html?sessionID=<inputsessionID>&sessionToken=<yoursessionToken>
Copy

If you would like to skip the user view, we have an API endpoint that you can hit to simulate the user interface being completed. The session Id and session token created in the earlier step must be used in the payload for this API request to work.

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>") // file path to PEM file  .withEndpoint("/agent")  .withPayload(new Payload(SKIP_UI))  .withMethod("POST")  .withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")  .build();​//get Yoti responseconst response = await request.execute();
Copy

Payload Example

JSON
    
 
{  "session_id": "YOUR_SESSION_ID",  "client_session_token": "YOUR_SESSION_TOKEN"}
Copy

Last updated on

Was this page helpful?