{"templateId":"markdown","versions":[{"version":"v1.40","label":"v1.40 STS","link":"/products/custody/v1.40/ui/get-started/register","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/v1.39/ui/get-started/register","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/ui/get-started/register","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/ui/get-started/register","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/ui/get-started/register","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/ui/get-started/register","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/ui/get-started/register","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Register and log in","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"register-and-log-in","__idx":0},"children":["Register and log in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Registration for the ","Ripple Custody"," UI is a two-step process:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The new user creates a new profile in the UI. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-profile"},"children":["Create a profile"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The user administrator creates a user account based on the user name and public key from step 1. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.34/ui/environment/user/create#create-a-user"},"children":["Create a user"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you can register or log in, you need to download the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ripple Custody: Auth & Sign"]}," app from your app store and install it on your mobile device."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-profile","__idx":2},"children":["Create a profile"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you create a profile, ","Ripple Custody",":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pairs your mobile device with the UI."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generates and stores your private authentication data on your mobile device. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.34/ui/authentication#keys-and-token"},"children":["Keys and token"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generates your public key, that the user administrator uses to create your user account."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a profile:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the UI login page:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a profile"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Continue"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"A QR code is displayed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/register-uiqr.6b47f9122d53879d36b8e0bb7eea9ce1ec6b44d0528c7dd8918a3bb8e4dffcd1.28294ce9.png","alt":"UI registration QR code"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the app:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get started"]},". ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The Pair your device page is displayed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/register-pair.f9471cf4d3d3e1f866d3fa0cc37ffe4e1ad8713579d83cea70ac710f13ce1f3d.28294ce9.png","alt":"App registration pair device"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scan"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Scan the QR code. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The Ripple Custody server address is filled in for you."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/register-address.2d9241b07097095e5f8ea4f8d127f961b3729d786a84d1db7a62de02721fd947.28294ce9.png","alt":"App registration server address"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":4},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Continue"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The Complete your profile page is displayed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/register-email.fdf958b7ab0ef5a80ad22f03d12b9e17e4192887dbc6f7581b5d606153032846.28294ce9.png","alt":"App registration server address"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":5},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter your email address."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Continue"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Your new public key is displayed in the Share your public key page."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/register-share.35c4f3a673c7c74228aec7830839ec790a3182e21f6b18d49beb838120defa4b.28294ce9.png","alt":"App registration share key"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Share the public key with your user administrator, using one of the following methods:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The on-screen QR code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["At the right of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Public key"]}," field, click the share icon and share the key with your preferred method."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Continue"]}," until you reach the final screen."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Finish"]},"."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your user administrator will use the key to create your user account."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When your user account is ready, you can log in."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"log-in","__idx":3},"children":["Log in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody"," includes the following two login types:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An internal user name and password."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If available, one or more external single sign-on (SSO) identity providers."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To log in to ","Ripple Custody",":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ","Ripple Custody"," UI, select one of the login options available to you:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To log in with your internal user name and password, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Harmonize"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To log in with SSO, select an identity provider, such as Azure AD."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/sso-login.fe2a6ab21669e7d6acb3774caca038c9224b7af3e63d1f40cf0ff00119fd3a88.28294ce9.png","alt":"Login options"},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The login options available depend on your configuration."," ","All users can log in with the internal user name and password."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody"," redirects you to a login page."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the login page, enter the details for the login type:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To log in with SSO, enter the details requested by the identity provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To log in with your standard user name and password:",{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter your email address."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/login-email.f5638a0aca74835fdebc46331795ea0c1890cb261aa30db2beb8378d3e2425b4.28294ce9.png","alt":"Enter email address"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Login"]},". A QR code is displayed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/login-qr.8c23b9bf4c521cf8775f74d3bb5e341587092cf7470c64e68527116788fab629.28294ce9.png","alt":"QR code in UI"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the app:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scan"]}," and scan the QR code. The app displays a set of numbers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/login-app.b4f2c2706dc7a2ac081736eb6cd33090ec0b71b5cd863e63dda6724b99b79ca7.28294ce9.png","alt":"Select number in app"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select the number that corresponds to the number displayed in the UI. In this example, the number to select is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["12"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If prompted, authenticate in your app."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody"," approves your login and redirects you to your dashboard."]}]}]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After login, select a domain in the drop-down at the top left to access the entities and operations available to your user in that domain."]}]},"headings":[{"value":"Register and log in","id":"register-and-log-in","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Create a profile","id":"create-a-profile","depth":2},{"value":"Log in","id":"log-in","depth":2}],"frontmatter":{"seo":{"title":"Register and log in"}},"lastModified":"2026-04-07T19:14:09.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.34/ui/get-started/register","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}