RESTAPI:Starting and editing a Transfer Session

Please note that the Cryptshare Server only allows this operation for verified sender addresses or verified email addresses (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 /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. An URL is returned where the current transfer session state can be requested and edited will be returned as HTTP Created header.

This tracking id is used for requesting the current state of the transfer session, editing the transfer session, registering and uploading transfer files, and finally finalizing the transfer.

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

Get the current transfer session state

GET /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.

Edit parameters inside the transfer session

PATCH /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.