Javascript API Reference

API Reference for the Rownd Javascript API

requestSignIn(opts)

Show the Rownd sign-in dialog, or automatically initiate a sign-in.

Examples

Prompt the user to sign in

requestSignIn() can be called without any parameters and the user can choose to sign in with any of your app’s configured sign-in methods.

rownd.requestSignIn()

Automatically sign in a user using their email

rownd.requestSignIn({
  identifier: '[e-mail]',
  auto_sign_in: true
})

Prompt the user to sign in with Google and save a referral code to their user data

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

Parameters

identifier · string

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.

Example

Email

  rownd.requestSignIn({ identifier: '[e-mail]' })

  rownd.requestSignIn({ identifier: '[phone]' })

auto_sign_in · boolean · default: "false"

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.

Example

Auto Sign-in

rownd.requestSignIn({
  identifier: '[e-mail]'.
  auto_sign_in: true
});

method · SignInMethod

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'

Example

Email

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

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

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

  rownd.requestSignIn({
    method: 'one_tap',
    method_options: {
      // This is optional. Let's you anchor the One Tap dialog to a specific
      // spot on the page.
      prompt_parent_id: '#one-tap-anchor-selector'
    }
  });

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

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

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

redirect · boolean · default: "true"

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.

Example

Disable Redirect

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

post_login_redirect · string

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

This overrides postLoginRedirectUrl and postRegistrationUrl if they are set.

Example

Absolute URL

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

rownd.requestSignIn({ post_login_redirect: '/some/path?signed_in=true' })

user_data · object

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

Example

Referral Code

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

include_user_data · boolean · default: "true"

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

Example

No User Data

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
})

intent · string

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.

Example

Sign Up

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

login_step · LoginStep

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

Example

Success

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

signOut()

Signs out the user, clearing their access token and user data

rownd.signOut()

getAccessToken()

Get the access token for the signed-in user.

Parameters

waitForToken · boolean · default: "false"

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.

Example

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

user

get() · Function

Gets the data associated with the current user

Example

// data = { user_id: "user_1235, email: "[e-mail]", referral_code: "ref_123" }
const data = await rownd.user.get();

set(user_data) · Function

Replaces all of the user data for the current user.

You can call set() prior to a user signing in. This can be useful to construct user data if your app supports an unauthenticated state.

Example

rownd.user.set({ email: "[e-mail]", referral_code: "ref_123"})

setValue(field_name, value) · Function

Sets a specific field in current user’s data.

Example

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

uploadFile(field_name, file) · Function

Upload a file for a specific field

The file parameter must be a javascript File. If the field name corresponds to an image field, the mime type of the file must have an “image/” prefix (e.g. “image/png”)

Example

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

manageAccount() · Function

Show the user profile dialog

Example

rownd.user.manageAccount()

Mobile

Desktop

auth

isVerifiedUser() · Function -> boolean

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).

Example

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

requestFields()

Prompt the user to enter values to save in their data. You can specify the fields, submit button content, and the queustion/prompt.

Examples

Prompt the user to enter their first and last name

rownd.requestFields({
  fields: ['first_name', 'last_name'],
  buttonText: 'Save name',
  questionText: 'What\'s your name?'
});

Mobile

Desktop

Parameters

fields · string[]

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

The fields must exist in your application’s Data Types in order to save the data to the user’s profile

bottonText · string

The text to show on the submit button

questionText · string

The prompt or question displayed on the dialog

near

near · object

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

ensureImplicitAccount() · function

Creates an implicit NEAR account for the current user if one doesn’t already exist

Example

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

LoginStep

A step in the Rownd sign-in dialog. Used when calling requestSignIn to show a specific step.

INIT · enum

NoAccount · enum

Success · enum

Error · enum

Completing · enum