com.yoti.api.client.docs.session.create.SessionSpec Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yoti-sdk-api Show documentation
Show all versions of yoti-sdk-api Show documentation
Java SDK for simple integration with the Yoti platform
The newest version!
package com.yoti.api.client.docs.session.create;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.yoti.api.client.docs.session.create.check.RequestedCheck;
import com.yoti.api.client.docs.session.create.filters.RequiredDocument;
import com.yoti.api.client.docs.session.create.identityprofile.advanced.AdvancedIdentityProfileRequirementsPayload;
import com.yoti.api.client.docs.session.create.resources.ResourceCreationContainer;
import com.yoti.api.client.docs.session.create.task.RequestedTask;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Definition for the Doc Scan Session to be created
*/
public class SessionSpec {
@JsonProperty(Property.CLIENT_SESSION_TOKEN_TTL)
private final Integer clientSessionTokenTtl;
@JsonProperty(Property.SESSION_DEADLINE)
private final ZonedDateTime sessionDeadline;
@JsonProperty(Property.RESOURCES_TTL)
private final Integer resourcesTtl;
@JsonProperty(Property.IMPORT_TOKEN)
private final ImportTokenPayload importToken;
@JsonProperty(Property.USER_TRACKING_ID)
private final String userTrackingId;
@JsonProperty(Property.NOTIFICATIONS)
private final NotificationConfig notifications;
@JsonProperty(Property.REQUESTED_CHECKS)
private final List> requestedChecks;
@JsonProperty(Property.REQUESTED_TASKS)
private final List> requestedTasks;
@JsonProperty(Property.SDK_CONFIG)
private final SdkConfig sdkConfig;
@JsonProperty(Property.REQUIRED_DOCUMENTS)
private final List requiredDocuments;
@JsonProperty(Property.BLOCK_BIOMETRIC_CONSENT)
private final Boolean blockBiometricConsent;
@JsonProperty(Property.IBV_OPTIONS)
private final IbvOptions ibvOptions;
@JsonProperty(Property.IDENTITY_PROFILE_REQUIREMENTS)
private final Map identityProfile;
@JsonProperty(Property.ADVANCED_IDENTITY_PROFILE_REQUIREMENTS)
private final AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements;
@JsonProperty(Property.SUBJECT)
private final Map subject;
@JsonProperty(Property.RESOURCES)
private final ResourceCreationContainer resources;
@JsonProperty(Property.CREATE_IDENTITY_PROFILE_PREVIEW)
private final Boolean createIdentityProfilePreview;
SessionSpec(Integer clientSessionTokenTtl,
Integer resourcesTtl,
ImportTokenPayload importToken,
String userTrackingId,
NotificationConfig notifications,
List> requestedChecks,
List> requestedTasks,
SdkConfig sdkConfig,
List requiredDocuments,
Boolean blockBiometricConsent,
IbvOptions ibvOptions,
ZonedDateTime sessionDeadline,
Map identityProfile,
Map subject,
ResourceCreationContainer resources,
Boolean createIdentityProfilePreview,
AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements) {
this.clientSessionTokenTtl = clientSessionTokenTtl;
this.resourcesTtl = resourcesTtl;
this.importToken = importToken;
this.userTrackingId = userTrackingId;
this.notifications = notifications;
this.requestedChecks = requestedChecks;
this.requestedTasks = requestedTasks;
this.sdkConfig = sdkConfig;
this.requiredDocuments = requiredDocuments;
this.blockBiometricConsent = blockBiometricConsent;
this.ibvOptions = ibvOptions;
this.sessionDeadline = sessionDeadline;
this.identityProfile = identityProfile;
this.subject = subject;
this.resources = resources;
this.createIdentityProfilePreview = createIdentityProfilePreview;
this.advancedIdentityProfileRequirements = advancedIdentityProfileRequirements;
}
public static Builder builder() {
return new SessionSpec.Builder();
}
/**
* client-session-token time-to-live to apply to the created session
*
* @return the client session token TTL
*/
public Integer getClientSessionTokenTtl() {
return clientSessionTokenTtl;
}
/**
* time-to-live used for all Resources created in the course of the session
*
* @return the resources TTL
*/
public Integer getResourcesTtl() {
return resourcesTtl;
}
/**
* Import token, allow documents verified in an IDV session to create a digital ID in the Yoti app
*
* @return the import token
*/
public ImportTokenPayload getImportToken() {
return importToken;
}
/**
* user tracking id, for the Relying Business to track returning users
*
* @return the user tracking ID
*/
public String getUserTrackingId() {
return userTrackingId;
}
/**
* {@link NotificationConfig} for configuring call-back messages
*
* @return the notification configuration
*/
public NotificationConfig getNotifications() {
return notifications;
}
/**
* List of {@link RequestedCheck} objects defining the Checks to be performed on each Document
*
* @return the requested checks
*/
public List> getRequestedChecks() {
return requestedChecks;
}
/**
* List of {@link RequestedTask} objects defining the Tasks to be performed on each Document
*
* @return the requested tasks
*/
public List> getRequestedTasks() {
return requestedTasks;
}
/**
* Retrieves the SDK configuration set on the session specification
*
* @return the {@link SdkConfig}
*/
public SdkConfig getSdkConfig() {
return sdkConfig;
}
/**
* List of {@link RequiredDocument} defining the documents required from the client
*
* @return the required documents
*/
public List getRequiredDocuments() {
return requiredDocuments;
}
/**
* Whether or not to block the collection of biometric consent
*
* @return should block biometric consent
*/
public Boolean getBlockBiometricConsent() {
return blockBiometricConsent;
}
/**
* The options that define if a session will be required to be performed
* using In-Branch Verification
*
* @return the IBV options
*/
public IbvOptions getIbvOptions() {
return ibvOptions;
}
/**
* The deadline that the session needs to be completed by.
*
* @return the session deadline
*/
public ZonedDateTime getSessionDeadline() {
return sessionDeadline;
}
/**
* Defines a required identity profile within the scope of a trust framework and scheme.
*
* @return Identity Profile
*/
public Object getIdentityProfile() {
return identityProfile;
}
/**
* The subject for which the identity assertion will be performed for the session.
*
* @return subject
*/
public Map getSubject() {
return subject;
}
/**
* The resources that should be created, when the session is created.
*
* @return resources
*/
public ResourceCreationContainer getResources() {
return resources;
}
/**
* Whether or not to create the identity profile preview
*
* @return should create the identity profile preview
*/
public Boolean getCreateIdentityProfilePreview() {
return createIdentityProfilePreview;
}
/**
* The Advanced Identity Profile that is being requested.
*
* @return the advanced identity profile payload
*/
public AdvancedIdentityProfileRequirementsPayload getAdvancedIdentityProfileRequirements() {
return advancedIdentityProfileRequirements;
}
public static class Builder {
private final List> requestedChecks;
private final List> requestedTasks;
private final List requiredDocuments;
private Integer clientSessionTokenTtl;
private Integer resourcesTtl;
private ImportTokenPayload importToken;
private String userTrackingId;
private NotificationConfig notifications;
private SdkConfig sdkConfig;
private Boolean blockBiometricConsent;
private IbvOptions ibvOptions;
private ZonedDateTime sessionDeadline;
private Map identityProfile;
private AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirementsPayload;
private Map subject;
private ResourceCreationContainer resources;
private Boolean createIdentityProfilePreview;
private Builder() {
requestedChecks = new ArrayList<>();
requestedTasks = new ArrayList<>();
requiredDocuments = new ArrayList<>();
}
/**
* Sets the client session token TTL (time-to-live)
*
* @param clientSessionTokenTtl the client session token TTL
* @return the builder
*/
public Builder withClientSessionTokenTtl(Integer clientSessionTokenTtl) {
this.clientSessionTokenTtl = clientSessionTokenTtl;
return this;
}
/**
* Sets the resources TTL (time-to-live)
*
* @param resourcesTtl the resources TTL
* @return the builder
*/
public Builder withResourcesTtl(Integer resourcesTtl) {
this.resourcesTtl = resourcesTtl;
return this;
}
/**
* Sets the {@link ImportTokenPayload}
*
* @param importToken the {@link ImportTokenPayload}
* @return the builder
*/
public Builder withImportToken(ImportTokenPayload importToken) {
this.importToken = importToken;
return this;
}
/**
* Sets the user tracking ID
*
* @param userTrackingId the user tracking ID
* @return the builder
*/
public Builder withUserTrackingId(String userTrackingId) {
this.userTrackingId = userTrackingId;
return this;
}
/**
* Sets the {@link NotificationConfig}
*
* @param notifications the {@link NotificationConfig}
* @return the builder
*/
public Builder withNotifications(NotificationConfig notifications) {
this.notifications = notifications;
return this;
}
/**
* Adds a {@link RequestedCheck} to the list
*
* @param requestedCheck the {@link RequestedCheck}
* @return the builder
*/
public Builder withRequestedCheck(RequestedCheck requestedCheck) {
this.requestedChecks.add(requestedCheck);
return this;
}
/**
* Adds a {@link RequestedTask} to the list
*
* @param requestedTask the {@link RequestedTask}
* @return the builder
*/
public Builder withRequestedTask(RequestedTask requestedTask) {
this.requestedTasks.add(requestedTask);
return this;
}
/**
* Sets the {@link SdkConfig}
*
* @param sdkConfig the {@link SdkConfig}
* @return the builder
*/
public Builder withSdkConfig(SdkConfig sdkConfig) {
this.sdkConfig = sdkConfig;
return this;
}
/**
* Adds a {@link RequiredDocument} to the list
*
* @param requiredDocument the {@code RequiredDocument}
* @return the builder
*/
public Builder withRequiredDocument(RequiredDocument requiredDocument) {
this.requiredDocuments.add(requiredDocument);
return this;
}
/**
* Sets whether to block the collection of biometric consent
*
* @param blockBiometricConsent block collection of biometric consent
* @return the builder
*/
public Builder withBlockBiometricConsent(boolean blockBiometricConsent) {
this.blockBiometricConsent = blockBiometricConsent;
return this;
}
/**
* Sets the options that define if a session will be required to be performed
* using In-Branch Verification
*
* @param ibvOptions the IBV options
* @return the builder
*/
public Builder withIbvOptions(IbvOptions ibvOptions) {
this.ibvOptions = ibvOptions;
return this;
}
/**
* Sets the deadline that the session must be completed by.
*
* @param sessionDeadline the session deadline
* @return the builder
*/
public Builder withSessionDeadline(ZonedDateTime sessionDeadline) {
this.sessionDeadline = sessionDeadline;
return this;
}
/**
* Sets the Identity Profile Requirements for the session
*
* @param identityProfile the Identity Profile
* @return the Builder
*/
public Builder withIdentityProfile(Map identityProfile) {
this.identityProfile = identityProfile;
return this;
}
/**
* Sets the subject for which the identity assertion will be performed for the session.
*
* @param subject the subject
* @return the Builder
*/
public Builder withSubject(Map subject) {
this.subject = subject;
return this;
}
/**
* Sets the resources that should be created, when the session is created.
*
* @param resources the resources
* @return the Builder
*/
public Builder withResources(ResourceCreationContainer resources) {
this.resources = resources;
return this;
}
/**
* Sets whether to create the identity profile preview
*
* @param createIdentityProfilePreview block collection of biometric consent
* @return the builder
*/
public Builder withCreateIdentityProfilePreview(boolean createIdentityProfilePreview) {
this.createIdentityProfilePreview = createIdentityProfilePreview;
return this;
}
/**
* Sets the advanced identity profile requirements to be requested
*
* @param advancedIdentityProfileRequirements the advanced identity profile requirements
* @return the builder
*/
public Builder withAdvancedIdentityProfileRequirements(AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements) {
this.advancedIdentityProfileRequirementsPayload = advancedIdentityProfileRequirements;
return this;
}
/**
* Builds the {@link SessionSpec} based on the values supplied to the builder
*
* @return the built {@link SessionSpec}
*/
public SessionSpec build() {
return new SessionSpec(
clientSessionTokenTtl,
resourcesTtl,
importToken,
userTrackingId,
notifications,
requestedChecks,
requestedTasks,
sdkConfig,
requiredDocuments,
blockBiometricConsent,
ibvOptions,
sessionDeadline,
identityProfile,
subject,
resources,
createIdentityProfilePreview,
advancedIdentityProfileRequirementsPayload);
}
}
private static final class Property {
private static final String CLIENT_SESSION_TOKEN_TTL = "client_session_token_ttl";
private static final String SESSION_DEADLINE = "session_deadline";
private static final String RESOURCES_TTL = "resources_ttl";
private static final String USER_TRACKING_ID = "user_tracking_id";
private static final String NOTIFICATIONS = "notifications";
private static final String REQUESTED_CHECKS = "requested_checks";
private static final String REQUESTED_TASKS = "requested_tasks";
private static final String SDK_CONFIG = "sdk_config";
private static final String REQUIRED_DOCUMENTS = "required_documents";
private static final String BLOCK_BIOMETRIC_CONSENT = "block_biometric_consent";
private static final String IBV_OPTIONS = "ibv_options";
private static final String IDENTITY_PROFILE_REQUIREMENTS = "identity_profile_requirements";
private static final String ADVANCED_IDENTITY_PROFILE_REQUIREMENTS = "advanced_identity_profile_requirements";
private static final String SUBJECT = "subject";
private static final String RESOURCES = "resources";
private static final String CREATE_IDENTITY_PROFILE_PREVIEW = "create_identity_profile_preview";
private static final String IMPORT_TOKEN = "import_token";
private Property() { }
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy