Skip to content

File Management Service

The File Management Service allows files to be uploaded and thereafter managed by Issuers.

Restricted Experimental Service

This service exists as an experiment to enable rapid prototyping of certain use-cases, such as linking to files / binary data within Credentials.

Ecosystems must be on a paid plan in order to make use of this service.

Data Security Precautions

Any file uploaded through this service is accessible over the internet to anyone who has the URL.

Although the URLs are extremely long and securely generated (thus are extremely costly to brute force), we do not recommend storing highly-sensitive files or documents via the File Management Service.

For example, government-issued IDs, social security cards, birth certificates, passports, etc. should not be uploaded to this service.

Service Creation

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

Upload File

Uploads a file to Trinsic's CDN.

contents must be the raw contents of the file, with a current maximum of 4 megabytes (4,194,304 bytes).

mime_type must be the MIME Type of the file you are uploading. This determines the file's resulting extension, as well as how it is treated when opened by a browser (displayed as an image, downloaded directly, etc.).

If you do not know the MIME Type of the file being uploaded, or otherwise cannot provide it, use application/octet-stream as a safe default.

The URL returned by this endpoint will contain a Hashlink query parameter, in the form of ?hl={hash}. The value of hash is a Multihash string, encoding the hash of the uploaded file contents.

The hl parameter is expected to be included with the URL whenever it is issued in a credential. This allows the cryptographic signature to cover the contents of the file (through its hash), without having to include the entire raw file contents in the credential itself.

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

UploadFileRequest
Request to upload a file to Trinsic's CDN
contents
bytes
Raw content of file
mime_type
string
MIME type describing file contents

UploadFileResponse
Response to UploadFileRequest
uploaded_file
File
Information about newly-uploaded file
Show child attributes

Get File

Fetches information about a file via its ID.

Only files uploaded by the calling account will be returned.

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

GetFileRequest
Request to fetch information about a stored file
id
string
ID of file to fetch

GetFileResponse
Response to GetFileRequest
file
File
File specified by id parameter of GetFileRequest.
Show child attributes

Delete File

Deletes a file from Trinsic's CDN.

Only files uploaded by the calling account may be deleted.

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

DeleteFileRequest
Request to delete a file from Trinsic's CDN by ID
id
string
ID of file to delete

DeleteFileResponse
Response to DeleteFileRequest. Empty payload.
This message has no fields

List Files

Queries the files uploaded by the calling account.

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

ListFilesRequest
Request to list files
query
string
Query to search with. If not specified, will return the most recent 100 files.
continuation_token
optional string
Token provided by previous ListFilesRequest if more data is available for query

ListFilesResponse
Response to ListFilesRequest
files
File[]
Files found by query
Show child attributes
has_more_results
bool
Whether more results are available for this query via continuation_token
continuation_token
string
Token to fetch next set of resuts via ListFilesRequest

Get Storage Statistics

Returns aggregate statistics regarding the files uploaded by the calling account.

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

GetStorageStatsRequest
Request to get statistics about files uploaded by this account
This message has no fields

GetStorageStatsResponse
Response to GetStorageStatsRequest
stats
StorageStats
Statistics about files uploaded by the calling account
Show child attributes