OneSpan Sign Developers: Virtual Room Recording – Part 2
In Part 1 of this ongoing blog series, we talked about how video recordings could improve the usefulness of the electronic evidence and ensure compliance. From there, we walked through the process to configure a transaction for Virtual Room recording.
Picking up where we left there, in this blog, we will showcase how the host can be notified when video recordings are ready to download and how to download the recordings programmatically. Without further delay, let’s get started!
Email Notification for Video Recording
After all signers have successfully completed the Virtual Room transaction, they will instantly receive a completion email like the normal signing flow, whereas the video recordings will still be processed behind the scene.
When the recordings are ready to download, the Virtual Room host will be notified with another notification email (“email.virtual.room.recording”):
The “GO TO RECORDINGS” link will lead the transaction owner to their sender portal where they can log in and download recordings from the transaction detail page.
It’s important to note that the video recordings will only be kept on OneSpan Sign server for 7 days after the transaction is completed, hence the transaction owner will start to receive notification emails (“email.virtual.room.recording.reminder”) three days before their removal.
Both email templates are fully customizable. Simply edit the content and send the email template in HTML format to our support team to set up in your account.
Query Recording Status
Besides being notified via the email notifications, your application can also actively query the status of the session recordings. In order to retrieve a list of available Virtual Room recordings for a given transaction, simply use the API below:
HTTP Request
GET /virtual-room-video/{packageId}/recordings
HTTP Headers
Authorization: Basic api_key / Bearer access_token Accept: application/json
Example Response
[
{
"uid": "a27a7763-2801-4fe7-b36b-009ea648ac67",
"fileName": "test_Virtual_Room_Recording-2022-04-29T16:22:12.mp4",
"creationDate": "2022-04-29T16:29:01Z",
"fileSize": "454703",
"fileFormat": "mp4",
"status": "enqueued",
"md5Hash": "879b1e9dc34680d9c7e526e6d2f0a569",
"deletionDate": "2022-05-07T02:30:00Z"
},
{
"uid": "c8719f57-fcb6-469d-b1f3-4ad231b16f61",
"fileName": "test_Virtual_Room_Recording-2022-04-29T16:30:49.mp4",
"creationDate": "2022-04-29T16:31:07Z",
"fileSize": "3065652",
"fileFormat": "mp4",
"status": "enqueued",
"md5Hash": "5b8a2d411e856fe68d8b4e28a1a5ca64",
"deletionDate": "2022-05-07T02:30:00Z"
}
]
After you receive the API response, note that there are three potential statuses:enqueued, completed, and deleted. For other attributes, the “uid” will be used later to download individual videos, and you could also store the “fileSize” and “md5Hash” to check the integrity of the downloaded videos.
Download Video Recording
When the video recording status is completed, you can programmatically fetch the video file using the API below:
HTTP Request
GET /virtual-room-video/{packageId}/download-recording/{recording_uid}
HTTP Headers
Authorization: Basic api_key / Bearer access_token Accept: application/json
Conclusion
In this blog, we have showcased you two methods to be notified the status and download the video recordings. In the next installation on this blog series, we will dive deeper into the callback notification support of the virtual room feature. If you have any questions regarding this blog or anything else concerning the integration of OneSpan Sign into your application, visit the Developer Community Forums. Your feedback matters to us!
