Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add FAQ #103

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions docs/wallet-provider-backend/FAQ_provider_backend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# FAQ Wallet Provider Backend

#### What is the Wallet Provider Backend?

- The Wallet Provider Backend is a system that enables administrators to configure wallet behaviors, manage verifiable credentials (VCs), and integrate external services for user authentication and credential issuance.
- It provides secure, scalable management of wallets for personal and enterprise use, supporting verifiable credentials in various formats.

### How do I set up the Wallet Provider Backend?

1. **Clone the Repository**: Download the project from the repository (e.g., GitHub).
2. **Install Dependencies**: Use `pip` to install necessary libraries.
3. **Configure Environment Variables**: Set up API keys, MongoDB credentials, Redis URL, and other provider settings in the environment configuration file.
4. **Run the Server**: Start the Flask server, ensuring connections to MongoDB and Redis are established.

### What APIs are available in the Wallet Provider Backend?

- **User Authentication API**: Provides secure OAuth2 and client-secret-based methods for managing user sessions.
- **Verifiable Credentials API**: Issue, store, and revoke VCs.
- **Configuration Management API**: Manage wallet types, issuer selections, and user roles.
- **Integration with Identity Providers**: Connect with external issuers and verifiers.

### How is user authentication handled?

- **OAuth2 and SIOPV2** are supported for secure authentication.
- Token-based authentication mechanisms are used to validate users' access and identity in the wallet app.

### How can I manage verifiable credentials?

- The backend supports multiple VC formats such as **JWT VC** and **LDP VC**.
- Credentials are securely stored in **MongoDB**, with encryption to ensure data privacy.
- VCs can be issued, revoked, and presented using the backend's APIs.

### What databases are supported?

- **MongoDB**: Used for long-term storage of users, credentials, and configurations.
- **Redis**: Provides session management and caching services.

### How do I configure wallet features via the backend?

- Configuration settings such as primary colors, wallet types, issuer preferences, and security options can be managed via the API or the admin dashboard.
- Updates to these configurations are applied dynamically, reflecting changes in the wallet app without requiring reinstallation.

### How do I deploy the Wallet Provider Backend?

1. **Prepare the Environment**: Set up the necessary environments (development, staging, production).
2. **Build the Backend**: Ensure all configurations, API keys, and credentials are correctly set in the environment files.
3. **Deploy**: Use deployment platforms such as **AWS**, **Google Cloud**, or **Heroku** for deployment.
4. **Monitor**: Use logging and monitoring tools to track backend performance and detect any issues.

### How are security and encryption managed?

- **OAuth2 and HTTPS** ensure secure communication between users and the backend.
- All sensitive data, including VCs and user information, is encrypted and stored securely in MongoDB.
- **Session management** is handled using tokens, with expiration policies for access control.

### How can I troubleshoot or debug the backend?

1. **Enable Debug Mode**: Set `LOGGING_LEVEL=debug` in your environment configuration.
2. **Check Logs**: Review the server logs for error messages and detailed tracebacks.
3. **Test APIs**: Use tools like **Postman** to test the API endpoints and ensure they are functioning correctly.
4. **Monitor MongoDB and Redis**: Ensure that database connections and queries are working without issues.

### What verifiable credential formats are supported?

- **JWT VC JSON**: Verifiable credentials in JSON Web Token format.
- **LDP VC**: Verifiable credentials using Linked Data Proofs.
- **SD-JWT**: A format offering selective disclosure JWT for increased privacy.

### How do I integrate with external issuers?

- You can integrate external issuers by using the API or admin dashboard.
- Provide the issuer's metadata, such as the URL, VC format, and credential type, to enable them to issue credentials to wallet users.
- Issuer settings can be configured to filter based on the selected VC format (e.g., JWT or LDP).

### How do I manage user roles and permissions?

- The Wallet Provider Backend supports **role-based access control**.
- You can define user roles (e.g., Admin, Organization, or User) and assign specific permissions for each role.
- Roles can be managed via the API or through the admin dashboard, ensuring that users have appropriate access to features based on their roles.
128 changes: 128 additions & 0 deletions docs/wallet/FAQ_wallet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# FAQ Wallet

# Talao FAQ

### What can I do with Talao?
Talao gives users the ability to take back control of their personal information and share it with Web 3 applications when required. For example, with Talao, users can present digital credentials (Over 18 proof, KYC, etc.) to access services or take advantage of offers (membership card, loyalty card, exclusive pass, etc.).

### Why is Talao called a Universal wallet and how is it different from other digital wallets?
Talao is called a 'Universal wallet' because, like a physical wallet that holds ID cards and funds, the Talao wallet gathers digital credentials (ID card, age proof, diploma, etc.) and digital assets (cryptos, NFTs, tokens). The wallet is built on Self-Sovereign Identity (SSI), which allows users to manage digital credentials in a decentralized and privacy-preserving way.

### What is Self-Sovereign Identity (SSI)?
Self-Sovereign Identity, or SSI, is a blockchain-compatible technology that gives users and organizations control over their digital credentials and identity data, without relying on a central authority. SSI allows users to manage and share their data privately and securely, using technologies like Zero-Knowledge Proof and Selective Disclosure to protect privacy.

### How can I use my Talao SSI wallet to manage and share my verifiable credentials?
When you receive a verifiable credential in Talao, it is added to your digital identity. You can use it to prove your identity or access services, like using a membership credential for members-only areas or an 'Over 18' proof for DeFi apps. Use the "scan" button to share credentials via QR code, then accept the request to share.

### What is the level of security of Talao wallet?
Talao wallet is self-custodial and secured with military-grade encryption and biometric authentication. Your data is encrypted and stored on your device, providing enhanced privacy and security.

### What does it mean that Talao is "self-custodial"?
A self-custodial wallet (non-custodial) means that your data is encrypted and stored on your device. Only you can access your keys, data, and assets—neither we nor anyone else can.

### Are there any risks related to verifying my address to get a 'proof of ownership' in Talao?
No, there is zero risk. You don’t need to share or disclose any passphrase or private keys to get a proof of ownership. Simply scan a QR code with your crypto wallet to receive a credential that proves you hold the private key of the address. Talao wallet is never connected to your crypto wallet.

### How does Talao wallet protect my personal information?
Talao uses SSI technology to store and manage personal information in a decentralized, secure, and private way. All personal information is encrypted and stored on your device. Only you control when and what data to share.

### Where are my digital credentials stored in Talao?
Your digital credentials are encrypted and stored on your phone. There is no central database or cloud storage. This decentralized model is why it’s called "Self-Sovereign Identity" (SSI)—you alone control your data.

### How do I backup my keys and credentials in Talao?
To back up your Talao wallet, write down your passphrase and download your digital credentials. Store them securely, such as in a password-protected file or physical safe. If you lose access to your wallet, there’s no way for us to recover it since Talao is self-custodial.

### What are Verifiable Credentials and why are they useful?
Verifiable Credentials (VCs) are an open standard for digital claims, representing information like ID cards, proof of age, or crypto address ownership. They are tamper-proof, digitally signed, and instantly verifiable by a third party, making them secure and reliable.

### What is 'Selective Disclosure'?
Selective Disclosure allows SSI users to reveal specific pieces of information about their identity without disclosing sensitive data. For example, you can prove you're 'Over 18' without revealing your name or address, enhancing security in online interactions.

### What is Talao and what makes it unique?
Talao is a "Universal wallet" that manages both digital credentials (e.g., identity proofs, diplomas) and digital assets (cryptos, NFTs). It is based on Self-Sovereign Identity (SSI), allowing users to control their digital identity in a decentralized and privacy-focused manner.

### What is Self-Sovereign Identity (SSI)?
SSI allows users to manage their own digital credentials without relying on a central authority. It provides decentralized identity management, enhanced privacy, and security through technologies like Zero-Knowledge Proof and Selective Disclosure.

### How does Talao protect personal information?
Talao uses SSI technology to encrypt and store data locally on the user’s device. Users control when and what data to share.

### How can I backup my keys and credentials in Talao?
You can back up your Talao wallet by writing down your passphrase and downloading your credentials. Store them securely in a password-protected file or physical safe.

### Why does my redirect not go to the App? (iOS/Android)
If redirection doesn’t happen automatically, go to your phone's settings > Settings > Apps > Altme/Talao > Set as default > Supported web addresses > app.altme.io -> On.

### What should I do if I find a bug or need support?
For bug reports or support, contact us at **[email protected]**.

### What are Talao's Terms of Service?
Visit our [Terms of Service](https://talao.io/).



# Altme FAQ


### What is the Altme Wallet ?
The Altme wallet is the world's first crypto wallet utilizing Decentralized Identity (DID) technology. It's a fully decentralized, non-custodial wallet for iOS and Android.
Altme acts as a gateway to Web 3, enabling users to connect with dApps, manage digital assets, and prove identity, age, liveness, and compliance through verifiable credentials.

### What are Verifiable Credentials ?
Verifiable credentials are [digital documents] (https://altme.io/verifiable-credentials/) that contains personal information like identity, name, age, and more !
VCs are issued by trusted authorities and are cryptographically signed, surpassing the security of traditional credentials. They are owned by the users, re-usable, fraud-proof, easy-to-share and easy-to-verify.

### What is Decentralized Identity (DID) ?
Decentralized Identity (DID), also known as Self-Sovereign Identity (SSI), is a digital identity model that gives individuals complete control over their personal data.
DIDs allow individuals to create and manage their own digital identities without relying on a centralized authority.

### How does Altme protect user privacy ?
Altme safeguards user privacy through the Self-Sovereign Identity standard, ensuring that users have complete ownership and control over their data.
Altme does not collect any user information. All data are entirely in the hands of individuals.

### How does Off-Chain verification work ?
Once a user's identity is verified, Altme issues cryptographically signed proofs (verifiable credentials) that are re-usable and instantly verifiable.
Users can then conveniently share their verified data off-chain via a QR code or link whenever needed.

### How does On-Chain verification work ?
After verification, users can create non-transferable NFTs (or SBTs) as binary proofs to confirm aspects about themselves on-chain. These proofs do not reveal any specific user data.
Decentralized applications (dApps) and smart contracts can then monitor users' verification status by checking for compliance SBTs in their wallets.

### How is Altme different from other wallets?
Altme wallet is built on Self-Sovereign Identity (SSI), a new digital identity standard that enables the management of digital credentials in a decentralized and privacy-preserving manner.

### How can I use/share my Verifiable Credentials?
When you obtain a verifiable credential in Altme, you can use it to prove things about yourself by scanning a simple QR code. For example, you can use your 'Over 18' proof to prove that you are over 18 years old to certain Web 3 applications.

### What is the level of security of Altme wallet?
Altme wallet is self-custodial and protected by military-grade encryption and biometric authentication. Your data is encrypted and stored on your device, enabling unbeatable privacy and security.

### What does it mean that Altme is 'self-custodial'?
A self-custodial (= non-custodial) wallet means that your digital assets and data are encrypted and stored on your device. Only you can access your keys, data, and assets. Not us. Not anyone else.

### Where are my personal data stored?
Your identity and personal data are encrypted and stored off-chain, on your phone.

### How do I backup my keys and verifiable credentials?
To backup your Altme wallet, write down your passphrase (12 words) and download your digital credential files, then store them in a secure location.

### What cryptocurrencies and NFTs are supported by Altme?
Altme supports tokens from several blockchains, including Ethereum, Polygon, Tezos, Fantom, BNB Chain…

### How can I deposit or withdraw funds from my Altme wallet?
You can purchase native coins directly in Altme and send them to your desired blockchain addresses.

### Can I trade cryptocurrencies using Altme?
While you cannot directly trade cryptocurrencies in Altme, you can easily connect your wallet with decentralized exchanges (DEX) to trade any coins.

### Is Altme available in languages other than English?
At this time, Altme is only available in English.

### How can I restore my wallet?
You can backup your Altme wallet by using your recovery phrase. Find your recovery phrase by going to “Parameters”, then “Wallet Security”, and finally “Show Wallet Recovery Phrase”.

### What if I lose my recovery phrase?
If you lose your recovery phrase, it is not possible for us to help you retrieve it. It is crucial to keep it in a safe and secure location.

### Why does my redirect not go to the App? (iOS/Android)
If the redirection is not done automatically, go to your phone's settings > Settings > Apps > Altme/Talao > Set as default > Supported web addresses > app.altme.io -> On.
2 changes: 2 additions & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ const sidebars: SidebarsConfig = {
'wallet/technical_features',
'wallet/verifier-configuration',
'wallet/wallet-metadata',
'wallet/FAQ_wallet',
],
},
{
Expand All @@ -48,6 +49,7 @@ const sidebars: SidebarsConfig = {
'wallet-provider-backend/issuer-marketplace',
'wallet-provider-backend/support',
'wallet-provider-backend/wallet-with-wallet-provider-backend',
'wallet-provider-backend/FAQ_provider_backend',
],
},
],
Expand Down