Appearance

Requesting Files ​

This page shows the full process for requesting files from other people using hxtransfer commands. You may also want to read more about the available commands, or how to configure the CLI. Working with existing transfers and sharing requests using the CLI involves using the ID field, read more about working with IDs.

Getting Started ​

Before you begin, ensure you have a working CLI installation by testing it with hxtransfer version, and that you have created an API key under your user account.

More info: hxtransfer version

Authenticating ​

Ensure your shell environment has the HXTRANSFER_API_KEY variable set to the full API Key, and if you are using a different service from https://transfer.hexiosec.com that you have also set HXTRANSFER_BASE_URL.

Test that you can sign in successfully:

text
$ hxtransfer auth

  ┌───────────────┬─────────────────────────┐
  │               │          Value          │
  ├───────────────┼─────────────────────────┤
  │ Authenticated │ true                    │
  ├───────────────┼─────────────────────────┤
  │ Email         │ [email protected]  │
  ├───────────────┼─────────────────────────┤
  │ Name          │ Your Name               │
  ├───────────────┼─────────────────────────┤
  │ User ID       │ XvOXgMS5thivsdfVOmyvvA  │
  └───────────────┴─────────────────────────┘

More info: hxtransfer auth

Creating a Sharing Request ​

Inviting other people to send you files via a sharing request starts with creating a link. This also includes a subject which is visible to the request recipient:

text
$ hxtransfer request create "Signed Documents"

ID:             CICysCMlQesdfWJHISE5Xg
Subject:        Signed Documents
Link:           https://transfer.hexiosec.com/i/CICysCMlQesdfWJHISE5Xg
Sharing Code:   I120B5C134N0YHSDFTC93J289TBR
State:          active
Created:        April 25, 2025 at 9:26 AM GMT+1
Deadline:       Not set
Keys:           Available
Received Files: 0

Important

Sharing request subject should be enclosed in quotes to ensure it is read correctly.

More info: hxtransfer request create

Either the Link or Sharing Code can be sent to your recipient. There is no difference in security between the two approaches, the link is more convenient however in some cases email systems have been known to corrupt parts of the link. Sharing Code can be used by pasting it into the home page.

Checking Sharing Request Status ​

In this example, using the ID from the previous step the status of the individual request can be checked as follows:

text
$ hxtransfer request cic

ID:             CICysCMlQesdfWJHISE5Xg
Subject:        Signed Documents
Link:           https://transfer.hexiosec.com/i/CICysCMlQesdfWJHISE5Xg
Sharing Code:   I120B5C134N0YHSDFTC93J289TBR
State:          active
Created:        April 25, 2025 at 9:26 AM GMT+1
Deadline:       Not set
Keys:           Available
Received Files: 1

Now that a recipient has uploaded files to the request link, the summary shows 1 Received Files.

More info: hxtransfer request ID

Showing Received Files ​

Sharing Requests can be used multiple times, and any received files are available for you to download for up to 30 days.

text
$ hxtransfer request files cic

  ┌────────────────────────┬───────────────────────────────────┬────────┬─────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┐
  │           ID           │            Description            │  Size  │                         Created                         │                         Expires                         │
  ├────────────────────────┼───────────────────────────────────┼────────┼─────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┤
  │ EovJYINpueasdf1PcCFKIQ │ Invite Response: Signed Documents │ 470110 │             April 25, 2025 at 9:39 AM GMT+1             │              May 25, 2025 at 9:39 AM GMT+1              │
  └────────────────────────┴───────────────────────────────────┴────────┴─────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┘

More info: hxtransfer request files ID

Downloading Received Files ​

Received files can be downloaded by the ID shown in the received file list:

text
$ hxtransfer download eov

Invite Response: Signed Documents
Created:   April 25, 2025 at 9:39 AM GMT+1
File Name: Contract_signed.pdf
Type:      application/pdf
Size:      469937 bytes

Without any additional arguments the file will be saved into the current working directory using the original file name and extension.

More info: hxtransfer download ID [DESTINATION]