Sandbox

npm install -S -E yoti

const { IDVClient } = require('yoti');

const fs = require('fs');

​

const SANDBOX_CLIENT_SDK_ID = 'YOUR_SANDBOX_SDK_ID';

const SANDBOX_PEM = fs.readFileSync('/path/to/your-sandbox-pem-file.pem', 'utf8');

​

// Initialise client with sandbox URL

const idvClient = new IDVClient(

    SANDBOX_CLIENT_SDK_ID, 

    SANDBOX_PEM, 

    { apiUrl: 'https://api.yoti.com/sandbox/idverify/v1' }

);

const {

    SessionSpecificationBuilder,

    RequestedDocumentAuthenticityCheckBuilder,

    RequestedLivenessCheckBuilder,

    RequestedFaceMatchCheckBuilder,

    RequestedTextExtractionTaskBuilder,

    SdkConfigBuilder

} = require('yoti');

​

// Define checks

const documentAuthenticityCheck = new RequestedDocumentAuthenticityCheckBuilder().build();

​

const livenessCheck = new RequestedLivenessCheckBuilder()

    .forStaticLiveness()

    .withMaxRetries(3)

    .build();

​

const faceMatchCheck = new RequestedFaceMatchCheckBuilder()

    .withManualCheckFallback()

    .build();

​

// Define tasks

const textExtractionTask = new RequestedTextExtractionTaskBuilder()

    .withManualCheckFallback()

    .build();

​

// Configure SDK

const sdkConfig = new SdkConfigBuilder()

    .withAllowsCamera()

    .withPresetIssuingCountry('GBR')

    .withSuccessUrl('https://yourdomain.com/success')

    .withErrorUrl('https://yourdomain.com/error')

    .build();

​

// Build session specification

const sessionSpec = new SessionSpecificationBuilder()

    .withClientSessionTokenTtl(900)

    .withResourcesTtl(90000)

    .withUserTrackingId('some-unique-user-id')

    .withRequestedCheck(documentAuthenticityCheck)

    .withRequestedCheck(livenessCheck)

    .withRequestedCheck(faceMatchCheck)

    .withRequestedTask(textExtractionTask)

    .withSdkConfig(sdkConfig)

    .build();

​

// Create session

idvClient.createSession(sessionSpec)

    .then((session) => {

        const sessionId = session.getSessionId();

        const clientSessionToken = session.getClientSessionToken();

        console.log('Session created:', sessionId);

    })

    .catch((err) => {

        console.error('Error creating session:', err);

    });

https://api.yoti.com/sandbox/idverify/v1/web/index.html?sessionID={sessionID}&sessionToken={clientSessionToken}

POST https://api.yoti.com/sandbox/idverify/v1/sessions/{sessionId}/agent

{

  "session_id": "YOUR_SESSION_ID",

  "client_session_token": "YOUR_SESSION_TOKEN"

}

const { RequestBuilder, Payload } = require("yoti");

​

const payload = {

  session_id: sessionId,

  client_session_token: clientSessionToken

};

​

const request = new RequestBuilder()

  .withBaseUrl("https://api.yoti.com/sandbox/idverify/v1")

  .withPemFilePath(SANDBOX_PEM_PATH)

  .withEndpoint("/agent")

  .withPayload(new Payload(payload))

  .withMethod("POST")

  .withQueryParam("sdkId", SANDBOX_CLIENT_SDK_ID)

  .build();

​

// Execute request

const response = await request.execute();

// Retrieve session result

idvClient.getSession(sessionId).then(session => {

    // Session state

    const state = session.getState();

    // Resources (documents, images)

    const resources = session.getResources();

    const idDocuments = resources.getIdDocuments();

    // Checks

    const authenticityChecks = session.getAuthenticityChecks();

    const livenessChecks = session.getLivenessChecks();

    const faceMatchChecks = session.getFaceMatchChecks();

    // Tasks

    const textExtractionTasks = session.getTextDataChecks();

    // Biometric consent

    const biometricConsent = session.getBiometricConsentTimestamp();

    console.log('Session completed successfully');

}).catch(error => {

    console.error('Error retrieving session:', error);

});

{

    "client_session_token_ttl": 433,

    "session_id": "bfaf87e8-51dc-4ee4-be7b-8d4e3d8e9f41",

    "state": "COMPLETED",

    "resources": {...},

    "checks": [...],

    "user_tracking_id": "12345"

}