RESTAPI:Starting and editing a Transfer Session

Please note that the Cryptshare Server only allows this operation for a verified sender address (see Verification).

}}For transferring data from a sender email address to a arbitrary number of recipient email addresses it is required to start a Transfer Session. During Transfer Session creation the sender email address and sender contact details have to be given as well as the recipients.

Create a transfer session

POST https://<your-url>/api/users/<sender email-address>/transfer-sessions

Using this endpoint, a new transfer session is created with all default settings that were configured in the Cryptshare Server administration interface.

Each transfer session is identified with the "tracking id" that has to be used for other transfer session related endpoints. This tracking id is returned in the response's Location header. The tracking id is integrated into the URL that can be used to get the current transfer session state, where also the transfer session can be edited (patch) and also finalized (post). For registering and upload files this url can be extended as well.

The values for sender language and recipient language can be pre-set by defining a locale via the Accept-Language header for this request.

Please note, it is not possible currently to change recipients after creating the transfer session.

Get the current transfer session state

GET https://<your-url>/api/users/<sender email-address>/transfer-sessions/<tracking-id>

Using this endpoint returns the currently configured transfer containing all information regarding sender, recipient and files information and the settings of the transfer itself.

Setting	Property	Read-only
Sender information (name & phone number)	sender	No
Expiration date	expirationDate	No
Security mode (one time password) (currently QUICK and eID are not supported)	securityMode	No
Password mode (generated, manual, none)	securityMode#passwordMode	No
Recipient notification (subject and mail text)	notificationMessage	No
Sender language	senderLanguage	No
Recipient language	recipientLanguage	No
If file names should be shown in notification emails	showFileNames	No
If file names inside zip files should be shown in notification emails	showZipFileContent	No
If recipients should be notified about the transfer	sendRecipientNotification	No
If the sender receives a confirmation email that the transfer was made accessible	sendUploadSummary	No
If the sender receives emails as soon as recipients download a file	sendDownloadNotifications	No
If a download summary mail should be sent after a transfer is expired	sendDownloadSummary	No
Classification id (could be used for your internal purposes)	classificationId	No
File checksum algorithm for your provided checksums	fileChecksumAlgorithm	No
The file ID of the confidential message	confidentialMessageFileId	No
Files	files	Yes
Recipients	recipients	Yes

Edit parameters inside the transfer session

PATCH https://<your-url>/api/users/<sender email-address>/transfer-sessions/<tracking-id>

Using this endpoint offers the ability to edit the respective transfer session regarding sender information and transfer settings.

Please note, it is not possible currently to change recipients after creating the transfer session.

For registering further transfer files please use the endpoint in Attaching files.