Quick start

Here is a quick reference to kickstart your SDK integration. For detailed information, we suggest you read through the step by step integration guide.

An example integration will include the steps highlighted in this section. We have provided code snippets in different languages to integrate Digital ID.

Install the SDK

You will need to ensure the latest version of the Yoti backend SDK is installed.

// Get the Yoti Node SDK library via the NPM registry

npm install -S -E yoti

// If you are using Maven, add the following dependency:

</dependency>

// If you are using Gradle, add the following dependency:

compile group: 'com.yoti', name: 'yoti-sdk-api', version: '3.8.0'

// Get the Yoti PHP SDK library via a Composer package

composer require yoti/yoti-php-sdk

// To install the Yoti NuGet package, you need to install NuGet Package Manager. After that, enter the following command in the console:

Install-Package Yoti

// For other installation methods, see https://www.nuget.org/packages/Yoti

// Simply add this as an import:

import "github.com/getyoti/yoti-go-sdk/v3"

// Or add the following line to your go.mod file

require github.com/getyoti/yoti-go-sdk/v3 v3.12.0

# Get the Yoti Python SDK library

pip install yoti

Initialise the Yoti Digital Identity Client using your SDK ID and PEM Key file.

const Yoti = require('yoti')

const CLIENT_SDK_ID = 'YOTI_CLIENT_SDK_ID'

const PEM_PATH = 'YOTI_KEY_FILE_PATH'

const PEM_KEY = fs.readFileSync(PEM_PATH)

const yotiClient = new Yoti.DigitalIdentityClient(CLIENT_SDK_ID, PEM_KEY)

import java.io.File;

import com.yoti.api.client.FileKeyPairSource;

import com.yoti.api.client.DigitalIdentityClient;

DigitalIdentityClient client = DigitalIdentityClient.builder()

.withClientSdkId("<YOTI_CLIENT_SDK_ID>")

.withKeyPairSource(FileKeyPairSource.fromFile(new File("<YOTI_KEY_FILE_PATH>")))

.build();

}

<?php

require_once './vendor/autoload.php';

$client = new \Yoti\DigitalIdentityClient('YOTI_CLIENT_SDK_ID', 'YOTI_KEY_FILE_PATH');

const string SDK_ID = "YOTI_CLIENT_SDK_ID";

const string PEM_PATH = "YOTI_KEY_FILE_PATH";

var privateKeyStream = System.IO.File.OpenText(PEM_PATH);

var yotiClient = new YotiDigitalIdentityClient(SDK_ID, privateKeyStream);

sdkID := "YOTI_CLIENT_SDK_ID";

pemKey, _ := ioutil.ReadFile("YOTI_KEY_FILE_PATH")

client, err := yoti.NewDigitalIdentityClient(sdkId, pemKey)

# Coming soon

Create share session

Use the Yoti client to configure and create a share session.

const {

DigitalIdentityBuilders: {

PolicyBuilder,

ShareSessionConfigurationBuilder,

}

} = require('yoti');

const policy = new PolicyBuilder()

// using a predefined method to add an attribute

.withFullName()

.withEmail()

// if you wish the user to prove it's them by taking a selfie on share

.withSelfieAuthentication()

.build();

const shareSessionConfig = new ShareSessionConfigurationBuilder()

.withRedirectUri("/your-callback")

.withPolicy(policy)

.build();

yotiClient.createShareSession(shareSessionConfig)

.then((shareSessionResult) => {

const shareSession = shareSessionResult;

const shareSessionId = shareSession.getId();

}).catch((error) => {

Policy policy = Policy.builder()

// using a predefined method to add an attribute

.withFullName()

.withEmail()

// if you wish the user to prove it's them by taking a selfie on share

.withSelfieAuthentication(true)

.build();

ShareSessionRequest shareSessionConfig = ShareSessionRequest.builder()

.withRedirectUri("/your-callback")

.withPolicy(policy)

.build();

try {

ShareSession shareSession = client.createShareSession(shareSessionConfig);

String shareSessionId = shareSession.getId();

} catch (DigitalIdentityException e) {

LOG.error(e.getMessage());

}

<?php

use Yoti\Identity\Policy\PolicyBuilder;

use Yoti\Exception\DigitalIdentityException;

$policy = (new PolicyBuilder())

// using a predefined method to add an attribute

->withFullName()

->withEmail()

// if you wish the user to prove it's them by taking a selfie on share

->withSelfieAuthentication()

->build();

$shareSessionConfig = (new ShareSessionRequestBuilder())

->withRedirectUri("your-callback")

->withPolicy($policy)

->build();

try {

$shareSession = $client->createShareSession($shareSessionConfig);

$shareSessionId = $shareSession->getId();

} catch (DigitalIdentityException e) {

throw new DigitalIdentityException($e->getMessage());

YotiPolicy policy = new YotiPolicyBuilder()

// using a predefined method to add an attribute

.withFullName()

.withEmail()

// if you wish the user to prove it's them by taking a selfie on share

.withSelfieAuthentication()

.Build();

ShareSessionConfiguration shareSessionConfig = new ShareSessionConfigurationBuilder()

.WithRedirectUri("/your-callback-url")

.WithPolicy(policy)

.Build();

ShareSession shareSession = yotiClient.CreateShareSession(shareSessionConfig);

var shareSessionId = shareSession.Id;

policy := (&digitalidentity.PolicyBuilder{})

// using a predefined method to add an attribute

.WithFullName()

.WithEmail()

// if you wish the user to prove it's them by taking a selfie on share

.WithSelfieAuth()

.Build()

shareSessionConfig := (&digitalidentity.ShareSessionBuilder{})

.WithRedirectUri("/your-callback-url")

.WithPolicy(policy)

.Build()

shareSession, err := client.CreateShareSession(shareSessionConfig)

if err != nil {

return nil, err

}

shareSessionId := shareSession.Id

# Coming soon

Client side view

Yoti provides a client-side script that you can include in your html file to display a Yoti button or inline QR code.

In the example below, use the modal button, but please feel free to look at our examples in our integration guide.

<head>

</head>

<body>

async function onSessionIdResolver() {

// Make a call to your backend, and return a 'sessionId'

const response = await fetch('http://localhost:3000/sessions', { method: 'POST' });

const data = await response.json();

return data.sessionId;

}

function onErrorListener(...data) {

console.warn('onErrorListener:', ...data);

}

const loadYoti = async () => {

const { Yoti } = window;

When a share is completed, the webpage where Yoti button/QR is rendered will automatically be redirected to the URL specified in the session configuration. The query parameter of redirectId will be attached to this URL.

You will then use use the receipt id to retrieve a user profile:

yotiClient.getShareReceipt(receiptId)

.then((shareReceipt) => {

const sessionId = shareReceipt.getSessionId();

const rememberMeId = shareReceipt.getRememberMeId();

const parentRememberMeId = shareReceipt.getParentRememberMeId();

const profile = shareReceipt.getProfile();

const fullName = profile.getFullName().value;

const dateOfBirth = profile.getDateOfBirth().getValue();

const gender = profile.getGender().getValue();

const nationality = profile.getNationality().getValue();

const postalAddress = profile.getPostalAddress().getValue();

const emailAddress = profile.getEmailAddress().getValue();

const phoneNumber = profile.getPhoneNumber().getValue();

const selfieImageData = profile.getSelfie().getValue();

const base64SelfieUri = selfieImageData.getBase64Content();

try {

Receipt shareReceipt = client.fetchShareReceipt(receiptId);

String sessionId = shareReceipt.getSessionId();

String rememberMeId = shareReceipt.getRememberMeId();

String parentRememberMeId = shareReceipt.getParentRememberMeId();

HumanProfile profile = shareReceipt.getProfile();

String fullName = profile.getFullName().getValue();

Date dateOfBirth = profile.getDateOfBirth().getValue();

String gender = profile.getGender().getValue();

String nationality = profile.getNationality().getValue();

String postalAddress = profile.getPostalAddress().getValue();

String emailAddress = profile.getEmailAddress().getValue();

String phoneNumber = profile.getPhoneNumber().getValue();

Image selfieImageData = profile.getSelfie().getValue();

<?php

$shareReceipt = $client->fetchShareReceipt($receiptId);

$sessionId = $shareReceipt->getSessionId();

$rememberMeId = $shareReceipt->getRememberMeId();

$parentRememberMeId = $shareReceipt->getParentRememberMeId();

$applicationProfile = $shareReceipt->getApplicationContent()->getProfile();

$applicationName = $applicationProfile->getApplicationName();

$profile = $shareReceipt->getProfile();

$fullName = $profile->getFullName()->getValue();

$dateOfBirth = $profile->getDateOfBirth()->getValue();

$nationality = $profile->getNationality()->getValue();

$postalAddress = $profile->getPostalAddress()->getValue();

$structuredPostalAddress = $profile->getStructuredPostalAddress()->getValue();

$selfieImageObj = $profile->getSelfie()->getValue();

$selfieImageBase64Content = $selfieImageObj->getBase64Content();

ShareReceipt shareReceipt = yotiClient.GetShareReceipt(receiptId);

DateTime? timestamp = shareReceipt.Timestamp;

string sessionId = shareReceipt.SessionId;

string rememberMeId = shareReceipt.RememberMeId;

YotiProfile profile = shareReceipt.Profile;

Image selfie = profile.Selfie?.GetValue();

string selfieURI = profile.Selfie?.GetValue().GetBase64URI();

string fullName = profile.FullName?.GetValue();

string emailAddress = profile.EmailAddress?.GetValue();

DateTime? dateOfBirth = profile.DateOfBirth?.GetValue();

string nationality = profile.Nationality?.GetValue();

string address = profile.Address?.GetValue();

bool hasIdentityProfile = profile.IdentityProfileReport != null ? true : false;

if (hasIdentityProfile) {

var identityProfileReport = profile.IdentityProfileReport.GetValue();

shareReceipt, err := client.GetShareReceipt(receiptId)

sessionId := shareReceipt.SessionID

rememberMeID := shareReceipt.RememberMeID

parentRememberMeID := shareReceipt.ParentRememberMeID

userProfile := shareReceipt.UserContent.UserProfile

selfie := userProfile.Selfie()

selfieBase64URL := selfie.Value().Base64URL()

fullName := userProfile.FullName().Value()

givenNames := userProfile.GivenNames().Value()

familyName := userProfile.FamilyName().Value()

mobileNumber := userProfile.MobileNumber().Value()

emailAddress := userProfile.EmailAddress().Value()

var dateOfBirth *time.Time

dobAttr, err := userProfile.DateOfBirth()

if err != nil {

// handle error

} else {

dateOfBirth = dobAttr.Value()

}

gender := userProfile.Gender().Value()

# Coming soon

Web examples

Our Github links below provide examples for the Digital ID Integration. Please select your preferred language to continue.

Production	Sandbox
Javascript	Javascript
Java	Java
PHP	PHP
.Net C#	.Net C#
Go	Go
Python	Python

Last updated on

Was this page helpful?

Quick start

Install the SDK

Client initialisation

Create share session

Client side view

Retrieve profile

Web examples