Package com.yoti.api.client.docs.session.create

Class SessionSpec

java.lang.Object
com.yoti.api.client.docs.session.create.SessionSpec
public class SessionSpec extends Object
Definition for the Doc Scan Session to be created

  • Method Details

    • builder

      public static SessionSpec.Builder builder()

    • getClientSessionTokenTtl

      public Integer getClientSessionTokenTtl()
      client-session-token time-to-live to apply to the created session
      Returns:
      the client session token TTL

    • getResourcesTtl

      public Integer getResourcesTtl()
      time-to-live used for all Resources created in the course of the session
      Returns:
      the resources TTL

    • getImportToken

      public ImportTokenPayload getImportToken()
      Import token, allow documents verified in an IDV session to create a digital ID in the Yoti app
      Returns:
      the import token

    • getUserTrackingId

      public String getUserTrackingId()
      user tracking id, for the Relying Business to track returning users
      Returns:
      the user tracking ID

    • getNotifications

      public NotificationConfig getNotifications()
      NotificationConfig for configuring call-back messages
      Returns:
      the notification configuration

    • getRequestedChecks

      public List<RequestedCheck<?>> getRequestedChecks()
      List of RequestedCheck objects defining the Checks to be performed on each Document
      Returns:
      the requested checks

    • getRequestedTasks

      public List<RequestedTask<?>> getRequestedTasks()
      List of RequestedTask objects defining the Tasks to be performed on each Document
      Returns:
      the requested tasks

    • getSdkConfig

      public SdkConfig getSdkConfig()
      Retrieves the SDK configuration set on the session specification
      Returns:
      the SdkConfig

    • getRequiredDocuments

      public List<RequiredDocument> getRequiredDocuments()
      List of RequiredDocument defining the documents required from the client
      Returns:
      the required documents

    • getBlockBiometricConsent

      public Boolean getBlockBiometricConsent()
      Whether or not to block the collection of biometric consent
      Returns:
      should block biometric consent

    • getIbvOptions

      public IbvOptions getIbvOptions()
      The options that define if a session will be required to be performed using In-Branch Verification
      Returns:
      the IBV options

    • getSessionDeadline

      public ZonedDateTime getSessionDeadline()
      The deadline that the session needs to be completed by.
      Returns:
      the session deadline

    • getIdentityProfile

      public Object getIdentityProfile()
      Defines a required identity profile within the scope of a trust framework and scheme.
      Returns:
      Identity Profile

    • getSubject

      public Map<String,Object> getSubject()
      The subject for which the identity assertion will be performed for the session.
      Returns:
      subject

    • getResources

      public ResourceCreationContainer getResources()
      The resources that should be created, when the session is created.
      Returns:
      resources

    • getCreateIdentityProfilePreview

      public Boolean getCreateIdentityProfilePreview()
      Whether or not to create the identity profile preview
      Returns:
      should create the identity profile preview