Virtual Room

OneSpan Sign’s Virtual Room is a virtual meeting room in which a host and signers from different locations can: (1) collaborate through a video conference call; (2) sign documents within a co-browsing session.

Virtual Room offers its users the following features:

• It is easy to use (e.g., there’s no need to download external software).

• Virtual Room meetings offer real-time interactions that mimic face-to-face interactions, providing simultaneous review, collaboration, assistance and clarification.

• Virtual Room meetings are secure. Only the right people are admitted, and Virtual Room supports all generally available methods for authenticating people’s identity.

• Each participant can configure their own audio and video settings for a Virtual Room meeting.

• Customers can customize most screens in their Virtual Room meetings (e.g., Welcome, Waiting Room, Authentication, Thank You). This means that they can prominently display their own brand throughout those meetings. To initiate the customization process, customers should contact their account representative in OneSpan’s Sales Department.

• The host controls the pace of a Virtual Room meeting (e.g., only the host can change documents; the host chooses who signs at given time).

• During a Virtual Room meeting: (1) participants can upload attachments, and can mask their attachments from other signers; (2) the host can see how many attachments the sender asked each recipient to upload.

• Electronic Evidence records most events of a Virtual Room meeting, thus ensuring a legally binding agreement.

Creating a Virtual Room Transaction

To create a Virtual Room transaction you must complete the following general procedures:

1. Create the transaction

2. Define the Virtual Room settings

3. Send the transaction

This section will describe how to define your Virtual Room settings. For more information, see Creating and Sending a Transaction.

Creating the Virtual Room Transaction

While this section provides the basic code required to create a transaction, you can also use other OneSpan Sign features at this point. For example, Attachments, and Signer Authentication.

While creating a Virtual Room transaction is similar to creating a regular transaction, in this code you must specify the Virtual Room host, and their Role ID. To do this, use the following code:

 DocumentPackage documentPackage = PackageBuilder.newPackageNamed("Example Virtual Room Transaction") 
      .withSigner(SignerBuilder.newSignerWithEmail("sender_email")
                  .withCustomId("Owner")
                  .withFirstName("Duo")
                  .withLastName("Liang"))
            .withSigner(SignerBuilder.newSignerWithEmail("signer1@mailinator.com")
                  .withCustomId("Signer1")
                  .withFirstName("Patty")
                  .withLastName("Galant"))
    .withDocument(DocumentBuilder.newDocumentWithName("Document1") 
            .fromFile("path_to_file") 
            .withSignature(SignatureBuilder.signatureFor("sender_email") 
                .onPage(0) 
                .atPosition(100, 140))
            .withSignature(SignatureBuilder.signatureFor("signer1@mailinator.com")
                .onPage(0) 
                .atPosition(100, 205)))
        .build();

PackageId packageId = eslClient.createPackageOneStep(documentPackage); 

Define and Send Your Virtual Room Tra4nsaction

Once the transaction has been created, you can define the settings to be used in the Virtual Room. For example:

• Whether cameras should be enabled

• Whether video recording should be enabled

• Host ID

• Start time

• Meeting duration

Then you can send your transaction.

To define and send your Virtual Room transaction, use the following code:

SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
simpleDateFormat.setTimeZone(TimeZone.getTimeZone("America/Toronto"));
Date vrDate = simpleDateFormat.parse("2022-04-23T09:30:00Z");
VirtualRoom virtualRoom = VirtualRoomBuilder.newVirtualRoom()
        .withHostUid("Owner")
        .withVideo(true)
        .withVideoRecording(true)
        .withStartDateTime(vrDate)
        .build();
eslClient.getVirtualRoomService().setVirtualRoom(packageId, virtualRoom); 

OneSpan Sign’s Virtual Room is a virtual meeting room in which a host and signers from different locations can: (1) collaborate through a video conference call; (2) sign documents within a co-browsing session.

Virtual Room offers its users the following features:

• It is easy to use (e.g., there’s no need to download external software).

• Virtual Room meetings offer real-time interactions that mimic face-to-face interactions, providing simultaneous review, collaboration, assistance and clarification.

• Virtual Room meetings are secure. Only the right people are admitted, and Virtual Room supports all generally available methods for authenticating people’s identity.

• Each participant can configure their own audio and video settings for a Virtual Room meeting.

• Customers can customize most screens in their Virtual Room meetings (e.g., Welcome, Waiting Room, Authentication, Thank You). This means that they can prominently display their own brand throughout those meetings. To initiate the customization process, customers should contact their account representative in OneSpan’s Sales Department.

• The host controls the pace of a Virtual Room meeting (e.g., only the host can change documents; the host chooses who signs at given time).

• During a Virtual Room meeting: (1) participants can upload attachments, and can mask their attachments from other signers; (2) the host can see how many attachments the sender asked each recipient to upload.

• Electronic Evidence records most events of a Virtual Room meeting, thus ensuring a legally binding agreement.

Define and Send Your Virtual Room Transaction

Once the transaction has been created, you can define the settings to be used in the Virtual Room. For example:

• Whether cameras should be enabled

• Whether video recording should be enabled

• Host ID

• Start time

• Meeting duration

Then you can send your transaction.

To define and send your Virtual Room transaction, use the following code:

  DocumentPackage documentPackage = PackageBuilder.NewPackageNamed("Example Virtual Room Transaction") 
        .WithSigner(SignerBuilder.NewSignerWithEmail("sender_email")
                     .WithCustomId("Owner")
                     .WithFirstName("Duo")
                     .WithLastName("Liang"))
        .WithSigner(SignerBuilder.NewSignerWithEmail("signer1@mailinator.com")
                      .WithCustomId("Signer1")
                      .WithFirstName("Patty")
                      .WithLastName("Galant"))
        .WithDocument(DocumentBuilder.NewDocumentNamed("Document1") 
                 .FromFile("path_to_file") 
                 .WithSignature(SignatureBuilder.SignatureFor("sender_email") 
                      .OnPage(0) 
                      .AtPosition(100, 140))
                 .WithSignature(SignatureBuilder.SignatureFor("signer1@mailinator.com")
                      .OnPage(0) 
                      .AtPosition(100, 205)))
             .Build();

  PackageId packageId = ossClient.CreatePackageOneStep(documentPackage);

  DateTime startDateTime = DateTime.UtcNow.AddDays(7);
  VirtualRoom virtualRoom = VirtualRoomBuilder.NewVirtualRoom()
          .WithHostUid("Owner")
          .WithVideo(true)
          .WithVideoRecording(true)
          .WithStartDateTime(startDateTime)
          .Build();
  ossClient.VirtualRoomService.SetVirtualRoom(packageId, virtualRoom);

  VirtualRoom vrConfig2 = ossClient.VirtualRoomService.GetVirtualRoom(packageId);
  Debug.WriteLine($"Virtual Room Config - Host ID: {vrConfig2.HostUid}; Start Date: {vrConfig2.StartDatetime}; Enable Video: {vrConfig2.Video}; Enable Recording: {vrConfig2.VideoRecording}.");
         
  ossClient.SendPackage(packageId);

Results

Here is an example of what you can expect to see once you have run your code.

OneSpan Sign’s Virtual Room is a virtual meeting room in which a host and signers from different locations can: (1) collaborate through a video conference call; (2) sign documents within a co-browsing session.

Virtual Room offers its users the following features:

• It is easy to use (e.g., there’s no need to download external software).

• Virtual Room meetings offer real-time interactions that mimic face-to-face interactions, providing simultaneous review, collaboration, assistance and clarification.

• Virtual Room meetings are secure. Only the right people are admitted, and Virtual Room supports all generally available methods for authenticating people’s identity.

• Each participant can configure their own audio and video settings for a Virtual Room meeting.

• Customers can customize most screens in their Virtual Room meetings (e.g., Welcome, Waiting Room, Authentication, Thank You). This means that they can prominently display their own brand throughout those meetings. To initiate the customization process, customers should contact their account representative in OneSpan’s Sales Department.

• The host controls the pace of a Virtual Room meeting (e.g., only the host can change documents; the host chooses who signs at given time).

• During a Virtual Room meeting: (1) participants can upload attachments, and can mask their attachments from other signers; (2) the host can see how many attachments the sender asked each recipient to upload.

• Electronic Evidence records most events of a Virtual Room meeting, thus ensuring a legally binding agreement.

Defining a Virtual Room Transaction

To create a Virtual Room transaction you must complete the following general procedures:

1. Create the transaction

2. Define the Virtual Room settings

3. Send the transaction

This section will describe how to define your Virtual Room settings. For more information, see Creating and Sending a Transaction.

Define Your Virtual Room Settings

Once the transaction has been created, you can define the settings to be used in the Virtual Room. For example:

• Whether cameras should be enabled

• Whether video recording should be enabled

• Host ID

• Start time

• Meeting duration

Then you can send your transaction.

To define and send your Virtual Room transaction, use the following code:

HTTP Request

 PUT /api/packages/{packageId}/virtual-room/config 

HTTP Headers

Authorization: Basic api_key / Bearer access_token
Accept: application/json
Content-Type: application/json 

Response Payload

 {
    "video": true,
    "videoRecording": false,
    "startDatetime": "2022-02-14T03:14:00.000Z",
    "hostUid": "Owner",
    "sessionTime": 60,
    "sessionTimeoutWarning": 15
}