Skip to main content
Docs
Dashboard

Web3 verification

These are all methods on the SignUp class that allow you to verify a user's sign-up request via a Web3 wallet.

prepareWeb3WalletVerification()

Helper method that allows you to initiate a verification process for a Web3 wallet. It sends the Web3 wallet address to the server and expects a nonce that will need to be signed.

This is equivalent to calling SignUp.prepareVerification("web3_metamask_signature").

function prepareWeb3WalletVerification(
  params?: PrepareWeb3WalletVerificationParams,
): Promise<SignUpResource>

PrepareWeb3WalletVerificationParams

  • Name
    strategy
    Type
    'web3_metamask_signature' | 'web3_coinbase_wallet_signature' | 'web3_okx_wallet_signature'
    Description

    The verification strategy to validate the user's sign-up request. The following strategies are supported:

    • 'web3_metamask_signature': User will need to sign a message and generate a signature using MetaMask browser extension.
    • 'web3_coinbase_wallet_signature': User will need to sign a message and generate a signature using Coinbase Wallet.
    • 'web3_okx_wallet_signature': User will need to sign a message and generate a signature using OKX Wallet.

attemptWeb3WalletVerification()

Helper method that attempts to complete the verification process for a Web3 wallet address.

function attemptWeb3WalletVerification(params: AttemptWeb3WalletVerificationParams): Promise<SignUp>

This is equivalent to calling SignUp.attemptVerification({strategy: "web3_metamask_signature", signature: "..." }).

AttemptWeb3WalletVerificationParams

  • Name
    signature
    Type
    string
    Description

    The signature that was generated after prepareVerification was called.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on