Embedded Wallets
SDK
Javascript
How to
Setup Authentication
Username
Register

Register with Custody Authentication

This method allows you to register a new Xellar Embedded wallet account using custody authentication.

Parameters

  • subId (string, required): User's subId for custody authentication.
  • options (object, optional): Configuration object.
    • rampable (object, optional): Rampable account configuration.
      • username (string): The username for the rampable account.
      • fullName (string): The full name for the rampable account.
      • password (string): The password for the rampable account.

Returns

An AuthSuccessResponse object containing the authentication tokens.

Example Usage

const subId = "user_sub_id_123";
const response = await sdk.auth.custody.register(subId);
ℹ️

The custody authentication method uses the provided subId to authenticate users without requiring username and password credentials.