Documentation
Tutorials
Creating a Basic React TypeScript App Run example app Styling
Github

Global

Members

enum

# AuthenticationMethod

Properties:
Name Type Description
Email string

OTP code to email contact point
Sms string

OTP code to SMS contact point
App string

TOTP code from an authenticator app
enum

# ButtonActions

Properties:
Name Type Description
signIn string

invoke sign-in process
signOut string

invoke sign-out process
signUp string

invoke sign-up process
updatePassword string

invoke update password process
checkIfUserSignIn string

check if user is signed in
updateUserData string

invoke user data commit
signUpNewApp string

invoke new app creation
enum

# ChangePasswordStep

Properties:
Name Type Description
password string

The user's current password
verifyOtp string

Verify password modification with OTP
verifyPassword string

Verify password modification with current password
enum

# ComponentName

User information field specifier type

Properties:
Name Type Description
firstName string

The user's first name
lastName string

The user's last name
email string

The user's email address
name string

The user's full name
address string

The user's address
username string

The user's selected username
birthdate string

The user's date of birth
country string

The country where the user resides
city string

The city where the user resides
zone string

The zone where the user resides
countrySelect string

Country selection
postalCode string

ZIP or postal code
addressOptional string

Address line 2 (e.g. apartment, suite, etc)
datePicker string

Date picker
enum

# LoadingType

Options for different loading types

enum

# SignSubjectType

Identity signature subject types

Properties:
Name Type Description
Credential string

Verfiable credential.
GenericJson string

Sign a generic, free-form, JSON message.
EthereumTransaction string

Ethereum transaction.
ERC20 string

ERC20 ethereum token transaction.
ERC721 string

ERC721 ethereum NFT transaction.
ZippiePayment string

Zippie payment object.
Unknown string

Unknown raw message.
enum

# ValidationType

Properties:
Name Type Description
required string

Validates if a specific field is not null
length string

Validates if the input meets the required character length
min string

Validates if the input meets the minimum character required
max string

Validates if the input exceeds the maximum character required
matches string

Checks if the input matches the character type required
email string

Checks if the input is a valid email address
url string

Checks if the input is a URL
uuid string

Checks if a value is a valid UUID
lowercase string

Transforms input into lowercase letters
uppercase string

Transforms input into uppercase letters

Methods

# usePlatform() → {PlatformContextType}

PlatformContextType

Type Definitions

# onAuthorizedCallback(result) → {void}

Callback when the identity has signed the subject.

Parameters:
Name Type Description
result any

Signature
void

# onAuthorizedCallback(result) → {void}

Callback when the identity has signed the subject.

Parameters:
Name Type Description
result any

Signature
void

# onBackClickCallback() → {void}

Callback when the user wants to go back to previous page

void

# onCancelClickCallback() → {void}

Callback when user cancel the action

void

# onContinueButtonClickCallback() → {void}

Callback when the user clicks on the continue button

void

# onDeleteCompleteCallback() → {void}

Callback when change password is complete

void

# onErrorCallback(error) → {void}

Callback if there was an error during the signing process.

Parameters:
Name Type Description
error Error
void

# onErrorCallback(error) → {void}

Callback if there was an error during the signing process.

Parameters:
Name Type Description
error Error
void

# onForgotPasswordClickCallback() → {void}

Callback when the user clicks on forgot password

void

# onIsValidChangeCallback(name, isValid) → {void}

Callback when isValid field change

Parameters:
Name Type Description
name string
isValid boolean
void

# onLoadCompleteCallback() → {void}

Callback when component is ready

void

# onPasswordChangeCompleteCallback(data) → {void}

Parameters:
Name Type Description
data IAppData
void

# onProfileChangedCallback(info) → {void}

Callback for profile switch to provide app with new app info

Parameters:
Name Type Description
info IAppData
void

# onRecoveryCompleteCallback(data) → {void}

Callback when recovery is complete

Parameters:
Name Type Description
data IAppData | PlatformError
void

# onRejectedCallback(reason) → {void}

Callback if the user rejected the signing process.

Parameters:
Name Type Description
reason any
void

# onRejectedCallback(reason) → {void}

Callback if the user rejected the signing process.

Parameters:
Name Type Description
reason any
void

# onSaveCompleteCallback(data) → {void}

Callback when the user complete the sign in process

Parameters:
Name Type Description
data IAppData
void

# onSignInButtonClickCallback() → {void}

Callback when the user click on login

void

# onSignInClickCallback() → {void}

Callback when moving to the next view

void

# onSignInCompleteCallback(data) → {void}

Callback when the user complete the sign in process

Parameters:
Name Type Description
data IAppData | PlatformError
void

# onSignUpClickCallback() → {void}

Callback when the user clicks on sign up

void

# onSignUpCompleteCallback(response) → {void}

Callback when the user complete the sign up process

Parameters:
Name Type Description
response IAppData | PlatformError
void