Javascript API Reference

An email address or phone number (in E164 format) to which a verification message may be sent. If the Rownd app is configured to allow unverified users, then sign-in will complete without verification if the user has not signed in previously.

This is frequently used in conjunction with auto_sign_in: true to automatically sign in a specific user.

  rownd.requestSignIn({ identifier: 'john.doe@acme.com' })

When true, automatically trigger a sign-in attempt if identifier is included or an email address or phone number has already been set in the user data.

rownd.requestSignIn({
  identifier: 'john.doe@acme.com'.
  auto_sign_in: true
});

If set, Rownd will initiate a sign-in with the specified method. Must be one of 'email', 'phone', 'google', 'one_tap', 'passkeys', 'crypto_wallet', or 'anonymous'

  rownd.requestSignIn({ method: 'email' });

After the sign-in completes, Rownd will redirect to the configured postLoginRedirectUrl or postRegistrationUrl. If false, the user will stay on the verification page. This can be helpful if your site or application cannnot be reached via a traditional redirect, such as if it’s running in an iframe.

rownd.requestSignIn({
  method: 'email',
  redirect: false,
})

An absolute or relative URL for which to redirect the user after the sign-in completes.

rownd.requestSignIn({ post_login_redirect: 'https:/my.site/signed_in' })

Extra user data to append to the user record when sign-in completes.

rownd.requestSignIn({
  user_data: {
    referral_code: 'ref_123'
  }
})

When true, user data that was previously set using rownd.user.set() will be added to the user record after sign-in.

rownd.user.set({ nick_name: 'Joey' })

...

// { 'nick_name': 'joey' } will not be added to the user's data
rownd.user.requestSignIn({
  include_user_data: false
})

This option applies only when you have opted to split the sign-up/sign-in flow via the Rownd dashboard. Valid values are "sign_in" or "sign_up". If you don’t set this value, the user will be presented with the unified sign-in/sign-up flow.

rownd.requestSignIn({ intent: 'sign_up' })

The step in the sign-in dialog to display. Must be one of LoginStep

rownd.requestSignIn({
  login_step: rownd.LoginStep.Success
})

When true, if no access token is present or if it’s expired, the promise will not be resolved until a valid token is available. While unlikely, this could result in waiting forever.

const token = await rownd.getAccessToken({ waitForToken: true });

Gets the data associated with the current user

// data = { user_id: "user_1235, email: "john.doe@acme.com", referral_code: "ref_123" }
const data = await rownd.user.get();

Replaces all of the user data for the current user.

rownd.user.set({ email: "john.doe@acme.com", referral_code: "ref_123"})

Sets a specific field in current user’s data.

rownd.user.setValue('referral_code', 'ref_123')

Upload a file for a specific field

rownd.user.uploadFile("profile_picture", file);

Show the user profile dialog

rownd.user.manageAccount()

• Mobile

• Desktop

Returns true if the current user is a verified user. In practice, this means that they have at least one piece of verified data (email, phone, etc).

if (rownd.auth.isVerifiedUser()) {
  console.log('verified!')
}

List of the field names for which to prompt the user.

The text to show on the submit button

The prompt or question displayed on the dialog

The near API allows you to interact with the Rownd’s NEAR integration.

const accountId = rownd.near.ensureImplicitAccount()

createNamedAccount()

function

Prompts the user to create a named NEAR account

Example

const accountId = rownd.near.createNamedAccount()

• Mobile

• Desktop

connectAccount()

function

Prompts the user to connect a NEAR accuont

Example

rownd.near.connectAccount()

• Mobile

• Desktop

walletDetails()

function

Opens a dialog showing the details of the user’s implicit NEAR account

Example

const accountId = rownd.near.walletDetails()

• Mobile

• Desktop