Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

Kalp Wallet - Open-API (1.0.0)

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://kalp-studio.redocly.app/_mock/untitled-1.yaml/
https://kalp-studio.redocly.app/{{HOST}}/
https://kalp-studio.redocly.app/{{base_url}}/

General Usage

Kalp Wallet OpenAPI provides an API that allows users to create and manage different types of wallets programmatically. The API supports the creation of self-custodial, MPC (Multi-Party Computation), and custodial wallets.

Request, Response & Error codes Copy

Authentication

FAQ

General FAQ

Q1: What types of wallets can I create using the Kalp Wallet API?
A1: You can create self-custodial, MPC (Multi-Party Computation), and custodial wallets using the Kalp Wallet API.

Q2: What formats are supported for request payloads?
A2: The Kalp Wallet API supports form-encoded (Content-Type: application/x-www-form-urlencoded), raw, form data, and JSON formats for request payloads.

Q3: How are responses formatted?
A3: Each response payload is encoded into JSON and contains either a successful result or an error message for failed or rejected requests.

Q4: How is authentication handled?
A4: Authentication is managed through API key middleware guards. The API key ensures that the request is from a valid user with the correct permissions.

Q5: What should I do if I encounter an error code?
A5: If you encounter an error code, refer to the detailed list of authentication and wallet errors provided. Each error code includes a description to help you understand the issue and how to resolve it.

Authentication FAQ

Q6: What does the error "Un Authorized , Invalid Access Token" mean?
A6: This error (Error Code: 1001) means that the access token provided is invalid. Ensure you are using a valid and authorized access token.

Q7: What should I do if I receive the "auth Api Key Missing" error?
A7: This error (Error Code: 1002) indicates that the API key is missing from your request. Ensure you include a valid API key in your request headers.

Q8: What does "max Otp Resend Attempts Exceeded" mean?
A8: This error (Error Code: 1003) occurs when you have exceeded the maximum number of OTP resend attempts. Wait for some time before requesting a new OTP.

Q9: Why am I getting the "Please Enter Valid Phone Number" error?
A9: This error (Error Code: 1004) indicates that the phone number entered is invalid. Ensure you enter a valid phone number.

Q10: What does "The OTP you entered has expired" mean?
A10: This error (Error Code: 1005) means that the OTP you entered has expired. Request a new OTP to proceed.

Q11: What should I do if I get the "Please Enter Valid Otp" error?
A11: This error (Error Code: 1006) indicates that the OTP entered is invalid. Ensure you enter the correct OTP sent to your phone or email.

Q12: What does "Unable to generate API key" mean?
A12: This error (Error Code: 1007) means that there was an issue generating the API key. Try again later or contact support for assistance.

Wallet FAQ

Q13: What does the error "Invalid Request Blockchain Not Supported Yet" mean?
A13: This error (Error Code: 101001) indicates that the requested blockchain is not supported by Kalp Wallet. Ensure you are requesting a supported blockchain.

Q14: Why am I getting the "RPC Node for the blockchain not found" error?
A14: This error (Error Code: 101002) means that the RPC node for the requested blockchain could not be found. Check your blockchain configuration.

Q15: What does "wallet Address not found for Current user" mean?
A15: This error (Error Code: 101003) indicates that the wallet address for the current user could not be found. Ensure the wallet address is correct and exists.

Q16: What should I do if I see the "wallet Type Is Self Custodial" error?
A16: This error (Error Code: 101004) means that the wallet type specified is self-custodial. Ensure you are handling the wallet type correctly.

Q17: What does "user Seed Phrase Mnemonics Mis Match" mean?
A17: This error (Error Code: 101005) indicates that the user seed phrase mnemonics do not match. Ensure the seed phrase is entered correctly.

Q18: Why am I getting the "RPC Node for the blockchain not found" error again?
A18: This error (Error Code: 101006) means the RPC node for the blockchain could not be fetched. Verify the blockchain network configuration.

Q19: What does "For Mpc Wallet User Shard Is Required" mean?
A19: This error (Error Code: 101007) indicates that a user shard is required for MPC wallet creation. Pass the user shard and user identity in the request body.

Q20: What should I do if I get the "no User Hashed Shard Found In DB" error?
A20: This error (Error Code: 101008) means that the user hashed shard could not be found in the database. Ensure you input the correct user shard or identifier.

Q21: What does "for Self Custodial Wallet Seed Phrase Is Required" mean?
A21: This error (Error Code: 101009) indicates that a seed phrase is required for self-custodial wallet creation. Pass the seed phrase in the request body.

Q22: What does "mnemonics/seedPhrase Expired" mean?
A22: This error (Error Code: 101010) means that the mnemonics or seed phrase has expired. Follow the instructions and complete the process within the specified time frame.

Q23: What should I do if I see the "for Mpc First Verify User Detail" error?
A23: This error (Error Code: 101011) indicates that you need to verify user details from MPC Auth before proceeding. Complete the verification step.

Q24: What does "seed Phrase Generation Can Be Only Done For Self Custodial Wallet" mean?
A24: This error (Error Code: 101012) indicates that seed phrase generation is only applicable for self-custodial wallets. Ensure you are using the correct wallet type.

Q25: Why am I getting the "No Transaction Abi Data Found" error?
A25: This error (Error Code: 101013) means that no transaction ABI data could be found. Verify the transaction details.

Q26: What does "for Mpc Wallet Can Not Send Route Transaction" mean?
A26: This error (Error Code: 101014) indicates that MPC wallets cannot send route transactions. Ensure the transaction type is supported.

Q27: What should I do if I get the "mpc Wallet Can Only Have User Shard" error?
A27: This error (Error Code: 101015) means that MPC wallets can only have user shards. Verify the wallet configuration.

Q28: What does "mpc Wallet Can Only Be Verified" mean?
A28: This error (Error Code: 101016) indicates that MPC wallets can only be verified. Complete the verification process.

Q29: What does "invalid Api Key ! Only Contract deployed User apiKey is valid" mean?
A29: This error (Error Code: 101017) means that the API key is invalid. Only the API key of the user who deployed the contract is valid.

Q30: Why am I getting the "only Custodial Wallet Address Can Sign Transaction through Generated Routes" error?
A30: This error (Error Code: 101018) means that only custodial wallet addresses can sign transactions through generated routes. Ensure you are using the correct wallet type.

Q31: What does "deployed Smart Contract Address Not Found in DB" mean?
A31: This error (Error Code: 101019) indicates that the deployed smart contract address could not be found in the database. Verify the smart contract address.

Q32: What should I do if I see the "user Auth Credential Already Exists" error?
A32: This error (Error Code: 101020) means that the social auth credential entered is already associated with an existing wallet. Use a different credential to create a new MPC wallet or log in to the existing wallet.

Q33: Why am I getting the "Invalid credentials or access denied" error?
A33: This error (Error Code: 101021) indicates that the credentials are invalid or access is denied. Check your credentials and try again.

API Reference

Operations