Create a Share session
After initialising the Yoti Identity Client, the next step is to configure your backend application to create a Share session. The Yoti SDKs enable integrators to dynamically create these sessions by defining a session configuration. A unique session would also include a share policy, which is a set of requested attributes or schemes for the sharing process.
Build a policy
A policy is used to define what attributes are requested from the user. You can use the policy builder to define what attributes are needed.
x
const { DigitalIdentityBuilders: { PolicyBuilder }} = 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();Specify the Session configuration
The Session configuration is built using:
- The policy.
- The redirect URI for share completion. This is where the user will be redirected to after the share is completed. A receiptId query parameter will be added to the URL. You can use this to retrieve the user profile from the share.
- A subject Id (optional).
- A notification webhook (optional).
- Any extensions.
const { DigitalIdentityBuilders: { ShareSessionNotificationBuilder, ShareSessionConfigurationBuilder }} = require('yoti');const notification = new ShareSessionNotificationBuilder() .withUrl("your-webhook-url") .withMethod("POST") .withHeader("Authorization", "<Bearer_token>") // Optional .withVerifiedTls(true) // Optional .build();const subject = { subject_id: 'some_subject_id_string',};const shareSessionConfig = new ShareSessionConfigurationBuilder() .withRedirectUri("/your-callback-url") .withPolicy(policy) .withSubject(subject) .withNotification(notification) .build();Create a Share session
Using the session configuration defined above, you can request the creation of a Share session that will be used by the Yoti Webshare script to generate a Yoti QR.
yotiClient.createShareSession(shareSessionConfig) .then((shareSessionResult) => { const shareSession = shareSessionResult; const shareSessionId = shareSession.getId(); }).catch((error) => { console.error(error.message); });Was this page helpful?