Products · Dash API

Account

Sign the person in to your dot with their Dash account.

dash.account.signIn

TypeScript
dash.account.signIn(options: SimpleSignInOptions, callOptions?: CallOptions): DashRequest<SimpleSignIn>

Signs the person in with their Dash account, and gives their full name, their phone number (or email if they have no phone) and an ID for them in your dot. Fails with denied if they say no, failed if no one is signed in or Dash can't reach Monime, and invalid for a nonce over 128 characters.

Permission in dot.json: account.

Types: SimpleSignInOptions, SimpleSignIn

Types

SimpleSignInOptions

FieldTypeWhat it is
mode'simple'Always 'simple'.
nonce (optional)stringLeave it out to get the same ID for the person every time. A different nonce gives a different ID, which can't be matched to their others. Up to 128 characters.

SimpleSignIn

FieldTypeWhat it is
fullNamestringThe person's full name on their Dash account, such as "Aminata Kamara".
aliasstringThe phone number or email address the person uses Dash with, such as "+232 76 123456". It's the phone number when the account has one.
accountIdTokenstringAn ID for this person in your dot. It's the same on any phone, and different in every other dot. Your server can't verify it came from Dash, so don't treat it as proof.

Keep reading