API Reference for the Rownd Javascript API
requestSignIn(opts)
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.
auto_sign_in: true
to automatically sign in a specific user.Example
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
'email'
, 'phone'
, 'google'
, 'one_tap'
, 'passkeys'
, 'crypto_wallet'
, or 'anonymous'
Example
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
postLoginRedirectUrl
and postRegistrationUrl
if they are set.Example
Example
true
, user data that was previously set using rownd.user.set()
will be added to
the user record after sign-in.Example
"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
signOut()
getAccessToken()
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
user
Example
set()
prior to a user signing in. This can be useful to construct user data if your app
supports an unauthenticated state.Example
Example
Example
Example
auth
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
requestFields()
near
near
API allows you to interact with the Rownd’s NEAR integration.Example
Example
Example
Example
LoginStep