Jump to Content
Guides
API Reference
Changelog
v1.0
v2.0
v3.0
Get API Key
Status
Support
Guides
Get API Key
Status
Support
Main
Guides
API Reference
Changelog
Search
Introduction 👋
Welcome to Venly!
Developer Portal
Pricing
Self-Custody Infrastructure
Pincode Management
Private Key Management
Quickstart Guide
Authentication
API Authentication
Widget Authentication
API Security Best Practices
Integrations
Zapier
Airtable x Venly
Eventbrite x Venly
Google Forms x Venly
Mailchimp x Venly
Monday.com x Venly
Google Sheets x Venly
Shopify
How to build an NFT store
How to create a collection
How to create an NFT
How to put an NFT for sale
How to change your plan
FAQ
Sitemanager
How to set up NFT project
How to update an NFT collection
How to update token template
How to token gate content
How to add a new NFT collection
How to add a new token template
MoonPay
Transak
Ramp Network
SDKs
C#
Async Operations
Javascript / Typescript
Faucets
Networks & URLs
Testnet Assets
WIDGET
Overview
Integration
Configuration
Getting started
Basic Guides
Initializing the widget
Selecting Environments and Networks
Authenticating with Venly
User authentication
Retrieve user profile
Retrieve user wallets
Retrieve wallet balance
Retrieve a user account
Retrieve token balance
Retrieve non-fungible tokens
Sign a message
Sign an EIP712 message
Execute Transactions
Transfer a native token
Transfer a ERC20 token
Transfer an NFT
Call a Contract
Chain specific fields
Wallet providers
Ethers.js
Wagmi
Web3-React
Web3Modal (WalletConnect)
Web3.js
Web3onboard
Function Reference
addOnTokenRefreshCallback
authenticate
checkAuthenticated
createSigner (deprecated)
executeContract
executeGasTransfer
executeNftTransfer
executeTokenAssociation
executeTokenTransfer
executeTransfer
getAccount
getAllNonFungibles
getBalance
getBalanceByAddress
getNonfungibles
getNonfungiblesByAddress
getProfile
getTokenBalance
getTokenBalanceByAddress
getTokenBalances
getTokenBalancesByAddress
getTransactionStatus
getWallet
getWallets
importWallet
linkWallets
logout
manageWallets
readContract
signEip712
signMessage
unlink
Object Reference
Account
AuthenticationOptions
AuthenticationResult
ConstructorOptions
ContractExecutionDto
ContractReadRequest
ContractReadResponse
Eip712SignRequestDto
GasTransferRequestDto
HederaTokenAssociationRequest
ImportWalletRequest
KeycloakInstance
MessageSignRequestDto
NFT
NFTContract
NftTransferRequestDto
PopupOptions
PopupResult
Profile
SecretType
Signer (deprecated)
SignerResult (deprecated)
RedirectOptions
TokenBalance
TokenTransferRequestDto
Trait
TransferRequestDto
TxStatusResult
VenlySubProviderOptions
Wallet
WalletBalance
WalletItems
WindowMode
WALLET API
Overview
Getting started
User Management
Signing Methods
Wallet Testnet Assets
Basic Guides
Create a user
Retrieve a user
Update a user
Delete a user
Create a signing method
Update a signing method
Delete a signing method
Create a wallet
Retrieve wallet
Archive a wallet
Import a wallet
Export a wallet
Retrieve native balance
Retrieve ERC20 tokens
Retrieve NFTs
Transfer a native token
Transfer an ERC20 token
Transfer an NFT
Transfer a fungible token
Signatures
Read a contract
Execute a contract call
Get Transaction status
Resubmit a transaction
Get wallet events
Webhooks
Advanced Guides
Burn an NFT
Filter Spam NFTs
Filter NSFW NFTs
SWAP Token Pairs
Gasless/Meta Transactions
Sign RAW Transactions
Using Fiat Onramp with Wallet-API
Deploy an Ethereum contract
Integrate with WalletConnect
Set Up NFT Token Gating
Chain Specific Fields
Integrate with WalletConnect
Encrypted PIN Transfer
Gasless tx/ Transfer with authorization - ERC20
Gasless tx/ permit & transferFrom - ERC20
Get gas fee for specific tx's
Token API
Overview
Getting started
Basic Guides
Create token contract
Check token contract status
Retrieve token contracts
Mint tokens
Get all ERC20 token mints
Check token mint request
Delete token contract
Update contract owner
Webhooks
Advanced Guides
Burn ERC20 Token
NFT API
Overview
Getting started
Migration to NFT v3
NFT Testnet Assets
Basic Guides
Get any NFT info
Get any NFT contract
Get NFTs by any wallet
Get wallets by any NFT
Create contract
Retrieve Contract
Delete Contract
Check Contract Status
Retrieve Contract Metadata
Update Contract Metadata
Create Token-type (NFT template)
Retrieve Token-type (NFT template)
Delete Token-type (NFT Template)
Check Token-type Status
Retrieve Token-type Metadata
Update Token-type Metadata
Mint an NFT
Batch Mint NFTs
Update NFT Metadata
Retrieve NFT Metadata
Add Audio to your NFTs
Add Video to your NFTs
Store NFT Media
Webhooks
Update contract owner
Update royalty for contract
Advanced Guides
Mass Minting
Speed Up Minting
Dynamic NFTs
Configure Royalties
Retrieve Company Minter Wallets
Store NFT Metadata on IPFS
View NFT on sandbox/testnet
Create token-type & directly mint NFTs
NFT Configuration
Attributes
Animation & Media
Collection Info
Max Supply
Mint Number
Burnable
Metadata Storage
PAY API
Overview
Getting started
Example Use Case Scenario
Basic Guides
Checkout Management
Customize Checkout Branding
Fetch Stripe Dashboard
Testing PAY
Fiat On/Off Ramps Configuration
Supported Fiat & Crypto for Providers
Fiat on-ramps
Fiat off-ramps
Configuring Webhooks
GAMING SDK
Overview
Unity
Getting started with Unity
Backend Provider: Developer Mode
Backend Provider: PlayFab
Create an Azure Cloud Function
Configure your PlayFab Account
Configure Venly SDK Manager
Backend Provider: Beamable
Configure Realm Config
Create Venly Microservice
Configure the Venly SDK Manager
Provide BeamContext (optional)
Server Authoritative
Backend Provider: Custom
Provider extensions
Function Reference
Object Reference
Unreal Engine
Getting started with Unreal Engine
Backend Provider: Developer Mode
Backend Provider: PlayFab
Create CloudFunction
Configuring the SDK
Backend Provider: Beamable
Beamable Microservice
Binding the Microservice
Provider Extensions
Function Reference
Object Reference
Game example 🎮
Use Cases
Simple NFT Application
Web2 Wallet onboarding
GENERAL
Blockchain Comparison
Custodial vs. Non-Custodial
Omnibus vs Segregated Wallets
Wallet-API vs Wallet-Widget
NFT contract vs collection
Powered by
Suggest
Check if a user is authenticated in Venly.
