5. Import a Wallet
Endpoint: Import Wallet
POST /api/wallets/import
/api/wallets/importThis endpoint is used to import a wallet by decrypting the provided data (such as password, mnemonic, and face) and creating a wallet on multiple blockchain platforms (e.g., Ethereum and Solana). The imported wallet is then securely stored and associated with the authenticated user.
Request
Endpoint:
/api/wallets/importMethod: POST
Content-Type:
application/json
Request Body
The request body should be a JSON object containing the following fields:
Fields:
password:
string(Optional) - The PGP encrypted password for the wallet. It will be decrypted on the server side.phrase:
string(Optional) - The PGP encrypted mnemonic phrase used to generate the wallet addresses. It will be decrypted on the server side.faceBase64:
string(Optional) - The PGP encrypted Base64-encoded facial data used for additional security or biometric verification. It will be decrypted on the server side.addServerPassword:
Boolean(Optional) - If true, a server-side password will be added to enhance security.preview:
Boolean(Optional) - If true, we return to you the ZelfProof without PGP encryption but in our servers will be added with the PGP Encryption to enhance security.removePGP:
Boolean(Optional) - If true, we are removing the decryption of the previous keys using PGP, all the variables are sent in plain text.
Example Request
Response
200 OK: The request was successful, and the wallet has been imported. The response contains details about the created wallet.
Response Body:
Internal Workflow Explanation
Decryption of Parameters:
The server receives encrypted data (password, mnemonic, faceBase64) and uses the
_decryptParamsfunction to decrypt these values. The decryption is performed using the authenticated user's private key, which is securely retrieved using the_getPrivateKeyfunction.
Wallet Creation:
Once the mnemonic phrase is decrypted, it is used to generate wallet addresses for different blockchains. The example provided shows the creation of Ethereum (
ethAddress) and Solana (solanaAddress) wallets using thecreateEthWalletandcreateSolanaWalletfunctions respectively.
Data Encryption for Storage:
The wallet data, including the blockchain addresses and decrypted mnemonic, is prepared for storage. This data is encrypted using the user’s face, password, and other parameters to ensure that it remains secure even when stored.
Saving the Wallet:
The final step is saving the imported wallet using the
_saveImportedWalletfunction, which securely stores the wallet data in the database, ensuring that it is associated with the authenticated user.
Use Cases
Multi-Blockchain Wallet Management: Users can import wallets that work across multiple blockchains (e.g., Ethereum, Solana) using a single mnemonic phrase, all while ensuring that their sensitive data remains encrypted and secure.
Biometric Security Integration: This endpoint allows the use of facial recognition as part of the encryption and decryption process, adding an extra layer of security for wallet management.
Error Handling
409 Conflict: Returned if the user is not passing the required params.
500 Internal Server Error: Returned if there is an issue on the server side while processing the request, such as failed wallet creation or saving.
Security Considerations
Encryption and Decryption:
All sensitive data (password, mnemonic, face) is encrypted before being sent to the server and is decrypted securely on the server side using the authenticated user’s private key. This ensures that no sensitive information is exposed in transit or at rest.
PGP Key Management:
The decryption process relies on the server securely retrieving and using the user’s PGP private key. This key is never exposed or transmitted insecurely, ensuring that the decryption of sensitive data is handled securely.
Biometric Integration:
The use of facial data as part of the encryption process ensures that the wallet can only be imported and accessed by the rightful owner, adding an additional layer of biometric security.
Last updated