wallet_registerOnboarding

MetaMask

Registers the requesting site with MetaMask as the initiator of onboarding, enabling MetaMask to redirect the user back to the site after onboarding. Returns a promise that resolves to true, or rejects if there's an error. Instead of calling this method directly, you should use the @metamask/onboarding library.

Params

(0)

Result

(RegisterOnboardingResult)

true if the request was successful, false otherwise.

boolean

Install MetaMask for your platform and refresh the page. The interactive features in this documentation require installing MetaMask.

Request

await window.ethereum.request({
  "method": "wallet_registerOnboarding",
  "params": []
});