Headers

WalletKit

API Reference

Dashboard

Join Discord

Change User Pin

Network

A 6-digit numeric pin that is only known to the user, set during wallet creation. This pin is required to sign transactions from this wallet.

UserPin

ChangeUserPinRequest

BearerAuth

ChangeUserPinResponse

ErrorResponse

Introduction

Supported Networks

We're so excited to show you Link and help you onboard your users

Overview

Let's get you set up with Link using our React SDK

Installation

Onboard users to your app with email, social login, or passkeys

Create wallet

Prompt the user to review, sign, and send a gasless transaction with their wallet

Prompt the user to sign a message with their wallet

Batch multiple transactions into a single on-chain transaction

Onboard users using their existing wallets via MetaMask, Coinbase, or WalletConnect

External connectors

Enable gasless wallets for users with EOA wallets

Sign-In With Ethereum

CORS origin

Use our Wallets API to create secure gasless wallets for your users

Use the walletkit-js library to integrate with the Wallets API in your web apps

Use the WalletKit swift package to integrate with the Wallets API in your iOS app

Use the WalletKit library to integrate with the Wallets API in your Android app

Authenticate your requests with WalletKit using server-side or client-side authentication.

Generate an access token for your users using their email address

Email

Generate an access token for your users by sending them a magic link to their email

Integrate with WalletKit API from server-side applications using your API key

API Key

Create a secure, smart, and gasless wallet controlled by the user.

Smart Contract Wallet

Create a secure EOA wallet controlled by the user

EOA Wallet

Send transaction

Batch transactions

Delegate transactions

Import wallet by private key, mnemonic phrase.

Import wallet

Export wallet

Retrieves activity history on a specific wallet address.

List Wallet Activity

List address metadata for provided addresses.

List Address Metadata

List NFT Collections

Creates an NFT Collection with provided metadata.
An NFT collection refers to a group of non-fungible tokens (NFTs) that are created and released together, often following a specific theme or concept. NFTs are unique digital assets that are stored on a blockchain, represent ownership or proof of authenticity of a particular item, artwork, or digital content.
The created nft collection's address can be found by `/transactions/status-by-id`
endpoint once the transaction is succeeded.


Create NFT Collection

Mint NFT

Transfers NFT from `from` to `recipient`. The from address must be wallet created in the project.

Transfer NFT

List NFTs by wallet or by collection address

List NFTs

Get NFT Collection

Upload NFT image

Get Token

Creates an on-chain token with provided metadata.

Create Token

Transfers the specified amount of tokens from `from` to `recipient`. The from address can only be the ones created in the project.

Transfer Token

Mints specified amount of token to the recipient.

Mint Token

Retrieves a list of token balances associated with a specific wallet address on a given network.

List Token Balances

Batch transfers from the `from` wallet to the list of
`recipients` with the provided amount. The `from` address can only be the ones
created in the project. Transfers within a batch are processed atomically
in a single transaction, resulting in significantly lower average costs
compared to individual transfers


Batch Transfer Token

Retrieves the status of a transaction by its hash.

Transaction Status By Hash

This endpoint allows arbitrary smart contract function calls. It can be used to interact with smart contracts that are not supported by the Token/NFT APIs.

Sign and Send

Signs a transaction without sending it to the blockchain.

Sign

This endpoint makes arbitrary smart contract function calls in batch.

Batch Sign and Send

This endpoint calculates a network-specific signature (e.g. in EIP-191 format EVM networks) for the provided message.

Sign Message

Retrieves the status of a transaction by its id returned from the APIs that change the state of blockchain` (e.g. /tokens/transfer)`

Transaction Status by ID

This endpoint allows you to preview a transaction’s execution without sending it to the blockchain.

Preview

This endpoint allows you to preview a bundle of transactions as it would execute on chain and returns results for each transaction.

Preview Bundle

Creates a policy that grants developers temporary permission to perform specific actions on users' behalf for a limited time.

Create Policy

List Policies

Revoke Policy

Begin Passkey Registration

Finish Passkey Registration

Log a user in with a discoverable passkey

Login with Discoverable Passkey

Login with Passkey

Create Session Challenge

Get Session Challenge

Log a user in with their wallet using Sign in with Ethereum.

Login with Wallet

Login with Email

Log a user in with their email and magic link

Login with Magic Link

Verify a user's login challenge and create a session.

Verify Login

Refresh Token

Log a user out and clear session cookies (only available in SDKs)

Logout

Get User Wallet by Network

Get Wallet by ID

Get Wallet by Address

Get Wallet by Owner ID

Lists wallets created in the project. Supports filter by network.

List Wallets

Create Wallet

Import a wallet with provided private key or mnemonic phrase.

Import Wallet

Export wallet mnemonic phrase or private key.

Activity

Addresses

NFTs

Tokens

Transactions

Policies

Users

Wallets

API Errors

Change User Pin

Headers

Authorizations

Body

Response

Activity

Addresses

NFTs

Tokens

Transactions

Policies

Users

Wallets

API Errors

​Headers

Authorizations

Body

Response

Headers