Frequently Asked Questions
Truestamp
Accounts
Q: How do I create a new account?
A: Click one of the 'Sign up' links or call to action buttons on the Truestamp website. From there you'll be able to create a new account using your email and password, or login using one of the available identity providers (e.g. Google, GitHub).
Q: How do I view/modify my account profile?
A: Once you're signed in to the Truestamp website, you'll be able to view your account profile. If you signed in using an identity provider, you'll need to modify your account profile on that provider's website.
Privacy
Q: How private is my personal data?
A: Truestamp is a public website. We do not collect any personal data from you other than that provided by your identity provider when you login. We encourage you to read out privacy policy and terms of use for additional information.
Q: How private is the data I submit for commitment by Truestamp?
A: In most cases, Truestamp will only know the cryptographic hash of the data you want to commit, and a description if you provide one. It is not possible for us to derive any information from the hash. Any data description you choose to provide is encrypted at rest and only accessible to you and the Truestamp team.
Q: Where is my data stored?
A: Currently, all data is stored in the cloud using a United States based cloud provider. You always have the option to download your own data commitments for independent verification. Data linked to the various public Blockchains that Truestamp uses is fully decentralized globally.
Scalability
Q: How scalable is Truestamp?
A: Truestamp was designed to operate at enterprise-level scale. It is designed to scale to handle large numbers of users, and the API is built to scale to handle large numbers of document commitments. If you have specific scale targets that you want to discuss, please reach out to us.
Q: Where is the Truestamp API hosted?
A: The Truestamp API currently runs on a highly scalable anycast network and is accessible from more than 250+ data centers around the world. Your requests will be routed to the closest data center.
Command Line Interface (CLI)
Software Development
Q: What language is the CLI written in?
A: The CLI is written in pure Typescript for Deno and compiled to a single-file executable.
Q: Is the CLI open source software?
A: The CLI source code, like all Truestamp client code, is available for you to review. It is not currently available under an open-source license.
Installation
Q: How do I install the Truestamp CLI?
A: The installation instructions for supported platforms can be found on the Truestamp CLI project page.
Q: Are there any dependencies needed before installing the Truestamp CLI?
A: No. The Truestamp CLI is a command line interface tool that is compiled to a single binary file with no dependencies. You can install it using a package manager on supported platforms, or by manually installing (or compiling) the binary on your system's PATH.
Uninstallation
Q: How do I uninstall the truestamp CLI binary?
A: If you installed the CLI using a package manager, you can uninstall it using the package manager's uninstall command. In all cases the installation is composed of a single executable file. Simply removing that single file will uninstall the program.
Platforms
Q: What platforms does the CLI run on?
A: The CLI is currently available on Linux, macOS, and Windows. You can learn more on the Truestamp CLI project page.
Q: Can I run the CLI on a Raspberry Pi?
A: Sorry, we don't currently support the Raspberry Pi. We're working on it! This is currently a limitation of the Deno cross compilation support.
Software Development Kit (SDK)
Supported Runtimes
Q: Which runtime environments does your SDK currently support?
A: We currently support JavaScript, and TypeScript with our Truestamp JS reference SDK.
Q: Can I use the Truestamp API from other runtime environments and programming languages?
A: Yes, we designed our API to be simple to use from any language and runtime environment by making simple HTTP REST API calls. Our OpenAPI documentation provides sample code usage in many programming languages.
Q: Can I use the Truestamp API using standard unix style command line tools?
A: Yes, its easy to use tools like curl or HTTPie to make HTTP requests to the Truestamp API. We provide examples in this documentation and in our OpenAPI API reference documentation.
API
API Keys
Q: When would I need to use an API key?
A: You do not need an API key to use the Truestamp website or CLI. Typically you'll want to use an API key if you want to use the Truestamp API from an application that is non-interactive such as if you have a server process or Lambda style function that needs to interact with the API with the same permissions as your user account.
Q: How do I get an API key?
A: As a user of the Truestamp API, you'll need to create an account. Once you've created an account, you'll be able to generate an API key. You can do this by visiting the Truestamp website and visiting your customer Dashboard, or by using the CLI.
Q: Do API keys expire?
A: Yes, API keys can optionally expire. When you create an API key, you can specify a duration for the key. If you don't specify a duration, the key will not expire.
Q: I lost control of an API key, can I revoke it?
A: Yes, but this will currently require assistance from the Truestamp team.
Support
Documentation
Q: I need help with doing, or understanding, something. How do I contact you?
A: You can always use the Intercom widget on our home page to contact us directly via live chat. Please also feel free to reach out by email to support@truestamp.com as well.
Q: I found a bug in the documentation, how do I help you fix it?
A: Thanks for asking! If you find a bug in one of our documentation pages you can either report it on our GitHub issues or use the 'Edit this page' link at the bottom of every page. You can always contact us by email with a link to the page, and the change you'd like to make as well.
Q: I have a suggestion to enhance the documentation, how do I help you improve it?
A: Thanks for asking! Please follow the same procedure documented in this section for filing a bug.