Quick Start

We suggest you read through the step-by-step integration guide to understand the integration in detail. Please see below for a quick start example and example projects.

Below is an example complete request snippet in different languages.

Install the SDK

Create a session

This is an example showing:

• One document authenticity check

• Text extraction

• Liveness

• Face match.

Launch the user interface

The next step is to load the Yoti client SDK. After a session is created a session id and a session token is received, we then use these to construct a URL which loads the Yoti Client SDK:

Retrieve results

The final step is to retrieve the results of the verification. Session retrieval requires the session ID, that was generated from the create a session endpoint. Below is a basic example of what retrieving a session looks like:

Node.jsJavaPhpPythonCsharpGoJson

Copy

// Returns a session result

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

// Returns the session state

const state = session.getState();

// Returns session resources

const resources = session.getResources();

// Returns all checks on the session

const checks = session.getChecks();

// Return specific check types

const authenticityChecks = session.getAuthenticityChecks();

const faceMatchChecks = session.getFaceMatchChecks();

const textDataChecks = session.getTextDataChecks();

const livenessChecks = session.getLivenessChecks();

const watchlistScreeningChecks = session.getWatchlistScreeningChecks();

const watchlistAdvancedCaChecks = session.getWatchlistAdvancedCaChecks();

// Returns biometric consent timestamp

// Returns a session result

GetSessionResult sessionResult = docScanClient.getSession(sessionId);

// Returns the session state

String state = sessionResult.getState();

// Returns session resources

ResourceContainer resources = sessionResult.getResources();

// Returns all checks on the session

List<? extends CheckResponse> checks = sessionResult.getChecks();

// Return specific check types

List<AuthenticityCheckResponse> authenticityChecks = sessionResult.getAuthenticityChecks();

List<FaceMatchCheckResponse> faceMatchChecks = sessionResult.getFaceMatchChecks();

List<TextDataCheckResponse> textDataChecks = sessionResult.getTextDataChecks();

List<LivenessCheckResponse> livenessChecks = sessionResult.getLivenessChecks();

List<WatchlistScreeningCheckResponse> watchlistScreeningChecks = getSessionResult.getWatchlistScreeningChecks();

<?php

// Returns a session result

$sessionResult = $docScanClient->getSession($sessionId);

// Returns the session state

$state = $sessionResult->getState();

// Returns session resources

$resources = $sessionResult->getResources();

// Returns all checks on the session

$checks = $sessionResult->getChecks();

// Return specific check types

$authenticityChecks = $sessionResult->getAuthenticityChecks();

$faceMatchChecks = $sessionResult->getFaceMatchChecks();

$textDataChecks = $sessionResult->getTextDataChecks();

$livenessChecks = $sessionResult->getLivenessChecks();

$watchlistScreeningChecks = $sessionResult->getWatchlistScreeningChecks();

$watchlistAdvancedCaChecks = $sessionResult->getWatchlistAdvancedCaChecks();

// Returns biometric consent timestamp

# Returns a session result

session_result = doc_scan_client.get_session(session_id)

# Returns the session state

state = session_result.state

# Returns session resources

resources = session_result.resources

# Returns all checks on the session

checks = session_result.checks

# Return specific check types

authenticity_checks = session_result.authenticity_checks

face_match_checks = session_result.face_match_checks

text_data_checks = session_result.text_data_checks

liveness_checks = session_result.liveness_checks

# Returns biometric consent timestamp

biometric_consent = session_result.biometric_consent_timestamp

// Returns a session result

GetSessionResult sessionResult = docScanClient.GetSession(sessionId);

// Returns the session state

string state = sessionResult.State;

// Returns session resources

ResourceContainer resources = sessionResult.Resources;

// Returns all checks on the session

List<CheckResponse> checks = sessionResult.Checks;

// Return specific check types

List<AuthenticityCheckResponse> authenticityChecks = sessionResult.GetAuthenticityChecks();

List<FaceMatchCheckResponse> faceMatchChecks = sessionResult.GetFaceMatchChecks();

List<TextDataCheckResponse> textDataChecks = sessionResult.GetTextDataChecks();

List<LivenessCheckResponse> livenessChecks = sessionResult.GetLivenessChecks();

// Returns biometric consent timestamp

DateTime biometricConsent = sessionResult.BiometricConsentTimestamp();

// Returns a session result

sessionResult, err := client.GetSession(sessionId)

// Returns the session state

state := sessionResult.State

// Returns session resources

resources := sessionResult.Resources

// Returns all checks on the session

checks := sessionResult.Checks

// Return specific check types

authenticityChecks := sessionResult.AuthenticityChecks()

faceMatchChecks := sessionResult.FaceMatchChecks()

textDataChecks := sessionResult.IDDocumentTextDataChecks()

livenessChecks := sessionResult.LivenessChecks()

// Returns biometric consent timestamp

biometricConsent := sessionResult.BiometricConsentTimestamp

›

›

{…}

Retrieve media

All data captured in an identity verification session can be fetched. Each data point is linked to a specific media id, the media id is then used in an API call to retrieve it's related media. Below is a basic example of what retrieving media looks like:

Delete session and media

It is possible to delete a session or images (media). This can only be done once the session is completed.

Deleting the session will also delete all media from that session. It's also possible to delete a single piece of media. Deleting a media object will delete only that specific object, leaving the rest of the session untouched.