Skip to main content

wallet_registerOnboarding

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 the request if there's an error. Instead of calling this method directly, you should use the @metamask/onboarding library.

Parameters

This method doesn't accept any parameters.

Returns

true if the request was successful, false otherwise.

Example request
await provider.request({
method: "wallet_registerOnboarding",
params: []
});
Example response
{
"id": 1,
"jsonrpc": "2.0",
"result": true
}