Sender-recipient transfer polling

This endpoint requires at least the Cryptshare REST API version 1.12.

Please note that the Cryptshare Server only allows this operation for a verified sender email address.

The Sender/Recipient Transfer Polling endpoints allow API consumers to list all transfers the verified sender or recipient email address has sent.

Request all transfers of a given sender/recipient

Sender

GET https://<your-url>/api/users/<sender email-address>/transfers/sent-transfers

Recipient

GET https://<your-url>/api/users/<sender email-address>/transfers/received-transfers

Due to a possible large number of transfers, pagination is used for this endpoint.

Further filtering parameters are also available.

Table 1. The parameters are query parameters for both endpoints.
Parameter name	Default value	Remarks
page	1	Page numbers are 1-indexed.
page-size	10	The maximum value for the page-size is 100.
active	active and inactive	To filter the result of the returned transfers set it as follows: active=true : only active transfers will be returned. active=false : only inactive transfers set will be returned. without sending or setting the value of this parameter the result transfers set will contain both the active and the inactive transfers
fields	trackingId, status(sender(email), recipients, state), transfer(recipients)	The parameter is used to select specific objects of the result transfers set. The "," is used to separate different selected object names. To select a nested objects inside one of the main ones, use the brackets () and again the object separator "," for the selected object properties e.g. status(recipients, state) Note that you can select multiple objects over multiple nested properties levels, e.g. status(state), transfer(recipients(to, cc), expirationDate, securityMode(config(passwordMode)))

For the recipient endpoint (/received-transfers) the sensitive information (download-Url, transfer-Files-IDs, confidential-Message-File-Id) is removed from the response, unless the endpoint client email address (verified) matches the transfer recipient email address .

The notificationMailLink is filtered out of both endpoints responses.

The default returned information contains a basic set of information for the transfer(s). Detailed information per transfer can be retrieved using the Transfer Status endpoint.

Table 2. The basic set of transfer information
Description	Property
The transfer identifier.	trackingId
The Recipients object of the transfer	status(recipients)
A set of recipient objects with mail and their individual transfer-id.	transfer(recipients)

Transfer State values

By using the fields parameter; adding the field Status(state) will obtain the transfer state value, which can be one of the following:

Table 3. Transfer States
State name	Description
Active	The transfer is available to be downloaded by the recipients.
Deleted_by_expiration	The transfer is not available anymore, due to reaching the expiration date.
Deleted_by_revocation	The transfer is not available anymore, due to revocation by the sender.
Deleted_by_admin	The transfer is not available anymore, due to deletion by the Cryptshare server administrator via the Transfer Log.
Deleted_by_security	The transfer is not available anymore, due to too many failed download attempts by recipients.
Processing	The transfer is not available yet. The finalization of this transfer-session was triggered, but is not finished yet.
Failed	The transfer is not available, due to all files being removed during finalization.

Remarks

Depending on the Cryptshare Server settings it might be that not all sent/recipient transfers are available due to the Automated Deletion of Expired Log Entries. This means, all transfers that expired before the configured amount of days will not be returned by this endpoint.

Cryptshare offers the possibility for users to request a deletion of their user data. After the deletion of their data, their email address is replaced by a proxy email address. Therefore, the set of recipients of a transfer might change after a deletion.

Deprecated sender polling API

The Sender Polling endpoint will continue to be available for the REST API versions 1.x, however it will be removed in the REST API version 2.0 (release date TBD) Please use the new version of the Sender polling endpoint instead: GET https://<your-url>/api/users/<sender email-address>/transfers/sent-transfers

The Sender Transfer Polling endpoint allow API consumers to list all transfers the verified sender email address has sent.

Request all transfers of a given sender

GET https://<your-url>/api/users/<sender email-address>/transfers

Due to a possible large number of transfers, pagination is used for this endpoint.

Table 4. The pagination parameters are **query parameters** for this endpoint.
Parameter name	Default value	Remarks
page	1	Page numbers are 1-indexed.
page-size	10	The maximum value for the page-size is 100.

The returned information contains a basic set of information for the transfers. Detailed information per transfer can be retrieved using the Transfer Status endpoint.

Table 5. The basic set of transfer information
Description	Property
The transfer identifier	trackingId
The current state of the transfer (see table below)	state
A set of recipient objects with mail and their individual transfer-id.	recipients
The URL for this transfer to access the Transfer Status endpoint	href