Create a session

AI Tools

Please use our Yoti SDKs to automatically build the relevant request.

The Yoti SDKs are available via popular dependency management systems.

Javascript
PHP
Python
Java
Go
C#
    
 
npm install -S -E yoti
Copy

Once you have added the Yoti SDK dependency to your project, you can use it to build and send your request. See the code snippets below for examples of how to construct the promise.

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("/sessions")  .withPayload(new Payload(SESSION_OBJ))  .withMethod("POST")  .withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")  .build();​//get Yoti responseconst response = await request.execute();
Copy

Creating Session Object

Below is the full payload example of the request for creating the session.

You will need to specify the identity profile scheme you wish to use:

RTW/RTR
DBS
IDENTITY
CUSTOM

Payload Examples

RTW
DBS
IDENTITY
CUSTOM
    
 
{  "client_session_token_ttl": 600,  "resources_ttl": 604800,  "user_tracking_id": "<YOUR_USER_ID>",  "notifications": {    "endpoint": "https://yourdomain.example/idverify/updates",    "topics": [      "resource_update",      "task_completion",      "check_completion",      "session_completion"    ],    "auth_token": "username:password"  },  "identity_profile_requirements": {        "trust_framework": "UK_TFIDA",        "scheme": {            "type": "RTW"        }    },  "sdk_config": {    "allowed_capture_methods": "CAMERA",    "primary_colour": "#2d9fff",    "success_url": "https://yourdomain.example/success",    "error_url": "https://yourdomain.example/error"  }}
Copy

Example Response

If the request is successful and a session is generated the API will send a response in the form:

JSON
    
 
{  "client_session_token_ttl": 599,  "client_session_token": "<uuid>",  "session_id": "<uuid>"}
Copy

Response	Description
client_session_token_ttl	Time in seconds until the client session expires
client_session_token	Used to authenticate the session
session_id	ID of the session

Last updated on

Was this page helpful?