| function() | \nDescription | \n
|---|---|
| async login( {loginOptions} ) | \nloginOptions={ provider, chainNetwork, email, phone, code, newAccountPassword }\n Logs the user in for the given provider (facebook, google, phone...)\n If performing a passwordless login, also include the email or phone, and code, otherwise these parameters are not needed.\n\n The `newAccountPassword` (OPTIONAL) Allows you to manually set a users password (Only available with **ORE ID Enterprise**)\n | \n
| logout() | \nLogs the user out. | \n
| async sign(signOptions) | \nsignOptions={ account, broadcast, callbackUrl, chainNetwork, state, transaction }\n \n Signs a transaction. The account, chainNetwork and transaction are required. The state can be any URL safe string that is passed back as a query parameter in the callbackUrl. Account is the 12 character account name.\n | \n
| async getUser(account) | \nAccount is the 12 character account name | \n
| async passwordlessSendCodeApi(options) | \noptions = { provider, phone, email }\n \n Provider is either 'email' or 'phone'. Pass in the phone number if provider is phone and email if the provider is email.\n | \n
| async passwordlessVerifyCodeApi(options) | \n\n options = { provider, phone, email, code }\n \n Provider is either 'email' or 'phone'. Pass in the phone number if provider is phone and email if the provider is email. The code is the code received in the sms or email sent to the user.\n | \n
| canDiscover(provider) | \nWhether an eos-transit enabled wallet supports key discovery - provider must be one of the eos-transit wallet provider names (e.g. scatter, ledger, etc.). See below for list.\n \n returns true or false\n | \n
| async discover(discoverOptions) | \ndiscoverOptions = {provider, chainNetwork} | \n
| async getConfig(configType) | \nconfigType = 'chains' is the only currently supported type | \n
| async addPermission(account, chainAccount, chainNetwork, publicKey, parentPermission, permission, provider) | \nprovider - one of facebook, google, phone...\n \n account - the 12 character account name\n \n publicKey - the public key you would like to add to the account\n | \n
| Error code | \nDescription | \n
|---|---|
| 400-404 | \nAn error occured on the client side. Make sure your hitting the correct endpoint URL. | \n
| 500-510 | \nAn error occured on the server side. Something went wrong on the server. Check to make sure the parameters you pass are valid. | \n
| Error code | \nDescription | \n
|---|---|
| app_access_token_missing_or_invalid | \nFor each request, pass in a valid app-access-token with each request. Each token can only be used once. You get a token by calling the /access-token API endpoint. | \n
| provider_missing_or_invalid | \nMust pass in one of the valid providers (i.e. facebook, google) with the auth request | \n
| cant_send_login_code | \nAn error occured trying to verify code used for passwordless login. | \n
| invalid_user_password | \nThe code sent for passwordless login was invalid or expired. | \n
| invalid_login_code | \nThe code sent for passwordless login was invalid or expired. | \n
| cant_verify_login_code | \nAn error occured trying to verify code used for passwordless login. | \n
| access_denied | \nThe code sent for passwordless login was invalid or expired. | \n
| unknown_error | \nAn unknown error occurred trying to login. | \n
| Error code | \nDescription | \n
|---|---|
| account_isnt_a_user | \nFailed to find the account | \n
| bad-param_app-access_token | \nFor each request, pass in a valid app-access-token with each request. Each token can only be used once. You get a token by calling the /access-token API endpoint. | \n
| missing-param_account | \nThe 'account' parameter was not found in the sign url. | \n
| missing-param_chain-network | \nThe 'chain_network' parameter was not found in the sign url. | \n
| missing-param_chain_account | \nThe 'chain_account' parameter was not found in the sign url. | \n
| missing-param_transaction | \nThe 'transaction' parameter was not found in the sign url. | \n
| badWalletPassword | \nThe password (or PIN) is not correct | \n
| sign_transaction_rejected | \nThe transaction being signed was rejected by the blockchain. | \n
| sign_transaction_unknown_error | \nThe transaction being signed is invalid. | \n
| callback_missing | \nThe 'callback_url' parameter was not found in the sign url. | \n
| callback_invalid | \nMake sure your callback url is included in the app registration settings. | \n