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.

Node.js
Java
PHP
C#
Go
Copy

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.
Node.js
Java
PHP
C#
Go
Copy

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.

Node.js
Java
PHP
C#
Go
Copy

Error codes

Error codeDescription
400Invalid request payload sent
400One or more of the specified attributes are not known
403Service is disabled
403Service does not belong to an organisation
403Organisation status must be PENDING or VERIFIED to perform shares
403Service isn’t allowed to request the specified 3rd party attribute
403Service isn’t allowed to issue the specified 3rd party attribute
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard