Account Service

The Account Service allows you to create and sign in to accounts.

Wallets vs Accounts

Wallets and accounts are related and often interchangeable -- each account has an associated wallet, and operations on a wallet are performed using an account's access token.

Every account has exactly one wallet.

Authentication Tokens

When you create or sign in to an account, the response is an authentication token string.

This string is an encoded form of your account profile, as well as an access key to perform calls using the account.

These are effectively API keys; they should be kept safe and never published.

---

Service Creation

Trinsic CLITypeScriptC#DartPythonGoJava

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

import 'package:trinsic_dart/src/account_service.dart';
import 'package:trinsic_dart/src/proto/services/account/v1/account.pb.dart';
import 'package:trinsic_dart/src/trinsic_service.dart';
import 'package:trinsic_dart/src/trinsic_util.dart';

Future<AccountService> getAccountService() async {
  var trinsic = TrinsicService(trinsicConfig(authToken: "[YOURAUTHTOKEN]"), null);
  var accountService = trinsic.account();
  return accountService;
}

---

Login / LoginConfirm

Attempts the first step of the login process for the specified account, creating it if it does not already exist. Trinsic will respond with a challenge, and send an authentication code to the account's email address. The authentication code must be passed along with challenge to LoginConfirm to finalize the login. Our SDK will take care of hashing the confirmation code for you.

SampleTrinsic CLITypeScriptC#DartPythonGoJava Request Response

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

  var loginResponse = await accountService.login(request: LoginRequest(
      ecosystemId: "your-ecosystem-id", email: "email@example.com"));
  var profile = await accountService.loginConfirm(
      Base64Encoder().convert(loginResponse.challenge), "[YOURCODE]");

      ⋯

var anonymousProfile = await accountService.loginAnonymous(ecosystemId: "your-ecosystem-id");

LoginRequest

Request to begin login flow

email

optional string

Email address of account. If unspecified, an anonymous account will be created.

invitation_code

optional string

DEPRECATED, will be removed April 1st 2023 Invitation code associated with this registration

ecosystem_id

optional string

ID of Ecosystem to sign into. Ignored if invitation_code is passed.

LoginResponse

Response to LoginRequest

challenge

bytes

Random byte sequence unique to this login request. If present, two-factor confirmation of login is required. Must be sent back, unaltered, in LoginConfirm.

profile

AccountProfile

Account profile response. If present, no confirmation of login is required.

Show child attributes

profile.profile_type

string

The type of profile, used to differentiate between protocol schemes or versions

profile.auth_data

bytes

Auth data containg information about the current device access

profile.auth_token

bytes

Secure token issued by server used to generate zero-knowledge proofs

profile.protection

TokenProtection

Token security information about the token. If token protection is enabled, implementations must supply protection secret before using the token for authentication.

Show child attributes

profile.protection.enabled

bool

Indicates if token is protected using a PIN, security code, HSM secret, etc.

profile.protection.method

ConfirmationMethod

The method used to protect the token

Show enum values

ConfirmationMethod.None

= 0

No confirmation required

ConfirmationMethod.Email

= 1

Email confirmation required

ConfirmationMethod.Sms

= 2

SMS confirmation required

ConfirmationMethod.ConnectedDevice

= 3

Confirmation from a connected device is required

ConfirmationMethod.Other

= 10

Third-party method of confirmation is required

Anonymous Login

Anonymous accounts are accounts which are not tied to any email or phone number, and do not require any authentication. They are typically used for testing and prototypes.

To create an anonymous account with an SDK, use the TrinsicService.LoginAnonymous() method.

To create an anonymous account with the CLI, simply leave the email parameter unspecified.

---

Get Account Info

Returns the account information (name, email address, phone number, etc.) used to create the currently-active account profile.

SampleTrinsic CLITypeScriptC#DartPythonGoJava Request Response

trinsic vc issue --document <JSONLD_FILE> --out <OUTPUT_FILE>

var info = await accountService.info();
print('Account info: EcosystemId=${info.ecosystemId} Email=${info.details.email}');

AccountInfoRequest

Request for information about the account used to make the request

This message has no fields

AccountInfoResponse

Information about the account used to make the request

details

AccountDetails

The account details associated with the calling request context

Show child attributes

details.name

optional string

Account name

details.email

optional string

Email address of account

details.sms

optional string

SMS number including country code

ecosystems

AccountEcosystem[]

Use ecosystem_id instead

Show child attributes

ecosystems[i].id

string

ecosystems[i].name

string

ecosystems[i].description

string

ecosystems[i].uri

string

wallet_id

string

The wallet ID associated with this account

device_id

string

The device ID associated with this account session

ecosystem_id

string

The ecosystem ID within which this account resides

public_did

string

The public DID associated with this account. This DID is used as the issuer when signing verifiable credentials

Note

This call returns the information associated with the authentication token used to create the request; therefore, it is not possible to pass a different authentication token to this call. Otherwise, Trinsic's zero-knowledge proof authentication scheme would be violated.

When using the CLI, this will return information for the account most recently logged in to.

When using the SDK, this will return information for the authentication token stored in the AccountService instance's ServiceOptions.AuthToken field, which will be the account most recently logged in to, unless you have manually set this value yourself.