![\"ORE](\"https://storage.googleapis.com/aikon-assets/Logo_OREIDMark_150.png\"){kind=logo}
The easiest way to use ORE ID is the eos-auth library
npm install oreid-js --save\nBest place to see how to use eos-auth is to check the example apps inside the ore-id-docs repo on Github. Look inside the examples folder in the repo.
\n\nimport { OreId } from 'oreid-js';\n\n// Create an OreId object to initialize the library\nlet oreId = new OreId({ appName:\"My App\", appId, apiKey, ... })\n\n// Start the OAuth flow by setting browser to URL returned by login\nlet loginResponse = await oreId.login({provider:'facebook'});\nwindow.location = loginResponse.loginUrl\n\n// Get the user's info given a blockchain account\nlet userInfo = await oreId.getUser(loginResponse.account)\n\n// Start the ORE ID signing process\nlet signResponse = await oreId.sign(signOptions)\nwindow.location = signResponse.signUrl\n\n// Start the signing process using local wallet app like scatter\nlet signResponse = await oreId.sign({provider:'scatter', chainNetwork:'eos_kylin', transaction, ...})\nconsole.log(signResponse.signedTransaction)\n\nHere are the public functions you can call inside eos-auth.
\nconst oreId = new OreId( {options} )
\nRequired options:
\nOptional options:
\n| 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 |
| 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
eos-transit is an open source project that provides compatibility with many EOS wallets. It is integrated into the ORE ID library. You can easily authenticate or sign with keys in a wallet by just using the transit wallet provider name as the 'provider' parameter in calls to the ORE ID library.
\nProviders for eos-transit enable wallets: keycat, ledger, lynx, meetone, metro, portis, scatter, simpleos, tokenpocket, whalevault
\nMore info: eos-transit repo on Github.
\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
(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_token\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImI2ZjhkNTVkYTUzNGVhOTFjYjJjYjAwZTFhZjRlOGUwY2RlY2E5M2QiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMDMxMDg1NzA2MzI2NzA5NDYyMjQiLCJlbWFpbCI6InRyYXkubGV3aW5AZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImF0X2hhc2giOiJIRmZ5YWFCVnQtTS1BUVQzMkl2VndBIiwibmFtZSI6IlRyYXkgTGV3aW4iLCJwaWN0dXJlIjoiaHR0cHM6Ly9saDMuZ29vZ2xldXNlcmNvbnRlbnQuY29tL2EtL0FPaDE0R2d6dDZYX2lYQ0tOQTNySG1fLWxEV3pPWGczV1NoVk5HOVFMdVpsPXM5Ni1jIiwiZ2l2ZW5fbmFtZSI6IlRyYXkiLCJmYW1pbHlfbmFtZSI6Ikxld2luIiwibG9jYWxlIjoiZW4iLCJpYXQiOjE2MjU2MTI1OTcsImV4cCI6MTYyNTYxNjE5N30.VmXSyeGV955_h63MVvVaL-gJGXm0uHWwMIDqIGrWdDqJ-cxim70y7Is6mGP5YH361qMFGpt1N-96BrJtvutIa7park6aum9eOCTXiqlsx-WWQjKyfx7IaaQrMpY8JTzOdSzi0dsccqrNnoY4CbSnhp0JLdNk5lH8Efc6hXlUTBktyPlC2dspxoho9OgJOH-9XUu6RNgoYaYDEDBfdEx3BAqvXHqTMwGFygRA0hnB98WRWUsEZ6N30sGjA3HeooGozHLEiVrZlN8ie-_PxGwoONGoU_5v-fJOleV8a9_nyFlxyhb8SPnCPYkEgOCMxZyizL9MJRtJ6FA2RiBu8QOFVw\"\n}"},"url":"service.oreid.io/api/account/convert-oauth","description":"Create a custodial account. Returns a 12 digit EOS account name (user’s ORE account name)
\nOptionally accepts id_token - A JWT OAuth token issued by a known OAuth provider (e.g. Google).\nIf an id_token is provided, the user will be created from the data in the token and no other user parameters (e.g. name, email) need to be included - they will all be extracted from the OAuth token. \nHowever, if a param is provided (e.g. user_Name), it will be used instead of the corresponding value in the Id Token - this allows you to override one or more values.\nImportant: In order to use an external id_token, your ORE ID App Registration must be configured to use it. \nAdditionally, Auth0 is an authorized OAuth provider. Tokens issues by your Auth0 domain can be used here as long as your Auth0 domain is registered in your ORE ID App Registration.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","convert-oauth"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"09a72c81-030c-4ef6-a9f7-cd091fa989d5","name":"Convert Oauth Tokens","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_token\": \"eyJhbGc...\"\n}"},"url":"service.oreid.io/api/account/convert-oauth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3003"},{"key":"ETag","value":"W/\"bbb-KJ+R1XLcBlyRfmBl876PGUq3gIM\""},{"key":"Date","value":"Tue, 06 Jul 2021 23:47:47 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"47d910365bbf\",\n \"accessToken\": \"eyJhbGci...\",\n \"idToken\": \"eyJhbGci...\"\n}"}],"_postman_id":"01a44221-c1c2-4547-b18e-337b2ee61e2e"},{"name":"UpdateDelayWalletSetup","id":"702258f8-d665-44fd-b96b-f0832f640919","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore\",\n \"delay_wallet_setup\": true\n}"},"url":"service.oreid.io/api/account/update-delay-wallet-setup","description":"Create a custodial account. Returns a 12 digit EOS account name (user’s ORE account name)
\nOptionally accepts id_token - A JWT OAuth token issued by a known OAuth provider (e.g. Google).\nIf an id_token is provided, the user will be created from the data in the token and no other user parameters (e.g. name, email) need to be included - they will all be extracted from the OAuth token. \nHowever, if a param is provided (e.g. user_Name), it will be used instead of the corresponding value in the Id Token - this allows you to override one or more values.\nImportant: In order to use an external id_token, your ORE ID App Registration must be configured to use it. \nAdditionally, Auth0 is an authorized OAuth provider. Tokens issues by your Auth0 domain can be used here as long as your Auth0 domain is registered in your ORE ID App Registration.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","update-delay-wallet-setup"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"ed0ceacc-e9ec-4648-bcee-060dc962753d","name":"Convert Oauth Tokens","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id_token\": \"eyJhbGc...\"\n}"},"url":"service.oreid.io/api/account/convert-oauth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3003"},{"key":"ETag","value":"W/\"bbb-KJ+R1XLcBlyRfmBl876PGUq3gIM\""},{"key":"Date","value":"Tue, 06 Jul 2021 23:47:47 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"47d910365bbf\",\n \"accessToken\": \"eyJhbGci...\",\n \"idToken\": \"eyJhbGci...\"\n}"}],"_postman_id":"702258f8-d665-44fd-b96b-f0832f640919"},{"name":"Get User","id":"0dcb20f5-7a71-4307-bc5f-4ccab9e5b1c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"","description":"(REQUIRED) The api-key for your application on ORE ID.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"service.oreid.io/api/account/user?account=ore1tdp2yqox","description":"This endpoint allows you to get the users information record.
\nCode: 400 Bad Request\n{\n \"message\": \"Problem handling /user request\",\n \"error\": \"Error: User not found\"\n}\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","user"],"host":["service.oreid.io"],"query":[{"key":"account","value":"ore1tdp2yqox"}],"variable":[]}},"response":[{"id":"93639ed6-c9f6-40dd-b4c6-baa6205909de","name":"Get User","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"","description":"(REQUIRED) The api-key for your application on ORE ID.","type":"text"}],"url":{"raw":"service.oreid.io/api/account/user?account=ore1pm2ctonu","host":["service.oreid.io"],"path":["api","account","user"],"query":[{"key":"account","value":"ore1pm2ctonu","description":"(Required) The users 12 character account name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:56:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"19f-SjGRJWmbW+DYlb5a7Uw9xVi36lc\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"ore1pm2ctonu\",\n \"email\": \"accounts@aikon.com\",\n \"picture\": \"https://storage.googleapis.com/oreid/images/user-oauth2|kakao|1028420577-profile.png\",\n \"name\": \"AIKON\",\n \"username\": \"AIKON\",\n \"permissions\": [\n {\n \"chainAccount\": \"ore1pm2ctonu\",\n \"chainNetwork\": \"eos_kylin\",\n \"permission\": \"app1pibyeurl\",\n \"isDefault\": false\n },\n {\n \"chainAccount\": \"ore1pm2ctonu\",\n \"chainNetwork\": \"ore_test\",\n \"permission\": \"app1pibyeurl\",\n \"isDefault\": false\n }\n ]\n}"}],"_postman_id":"0dcb20f5-7a71-4307-bc5f-4ccab9e5b1c5"},{"name":"Get App Token","id":"130ffe5d-0832-488a-a2a0-e46b3e02399d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"description":"(OPTIONAL) The service account key for ORE ID Enterprise
\n","key":"service-key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n\t\"newAccountPassword\": \"1101\"\t\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/app-token","description":"Returns an app_access_token which is needed for authenticating users and signing transactions.
\nnewAccountPassword - (Optional) - User's new password during account creation.
\ncurrentAccountPassword - (Optional) - User's current password prior to a password reset flow
\nsecrets - (Optional) - An array of values {‘mySecretType1’: ‘mySecretValue’} needed by a backend process (depends on specific flow).
\nappAccessToken - App Access Token.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","app-token"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"3b38148c-eed1-4324-8af3-4277036e0f45","name":"Get App Token","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"","type":"text","description":"(REQUIRED) The api-key for your application on ORE ID."},{"key":"service-key","value":"","description":"(OPTIONAL) The service account key for ORE ID Enterprise","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"newAccountPassword\": \"SomeNewPassword\",\n \"currentAccountPassword\": \"CurrentUserPassword\",\n \"secrets\": [\n {\"RepublicAccountRecoveryToken\": \"Some Secret Value\"}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/app-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"appAccessToken\": \"e12a6fbe-371d-42ba-8014-6c70a225f62c\"\n}"}],"_postman_id":"130ffe5d-0832-488a-a2a0-e46b3e02399d"},{"name":"Login User With Token","id":"50bc1c93-6a03-4595-a588-fa75f703d94e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"access_token\":\"ya29.A0AVA9y1srAyV-BPxY40dGnXPmKLGxPPeIqlKYYgOZwld36ftCRdw_ivcYjWMdaHlZEXQXp1vxEa_trLFuHTjWVBQbHdR_31i-4zU71R-KXoOHqApfS0ncmusGKyq6_CxmB0QFBWd_0wU0kxr_4zcIs1EONlm5XSMaCgYKATASATASFQE65dr8_lYEkTongsaeoIFCwWclFg0166\",\n \"provider\": \"google\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/account/login-user-with-token","description":"Returns an OAuth accessToken which may be included in the header of future requests to other api endpoints. The access token is scoped to a single user
\nid_token - Id token issued by an Oauth provider. The Oauth provider domain (iss) must be registered in your ORE ID app registration
\naccount - user's unique account (Ore ID). This can be thought of the userID used to specify the user in future requests
\naccessToken - access_token which may be included in the header of future requests to other api endpoints
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","login-user-with-token"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"8f884807-943a-4451-a6ca-e02ebc8327d2","name":"Login User With Token","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id_token\": \"eyJhbGc...\"\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/account/login-user-with-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"account\": \"ore123456789\",\n \"accessToken\": \"ey...\"\n}"}],"_postman_id":"50bc1c93-6a03-4595-a588-fa75f703d94e"},{"name":"New User With Token","id":"9ad14572-b4dd-4c83-975b-46d2c5204734","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"description":"(OPTIONAL) The service account key for ORE ID Enterprise
\n","key":"service-key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"id_token\":\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImVlMWI5Zjg4Y2ZlMzE1MWRkZDI4NGE2MWJmOGNlY2Y2NTliMTMwY2YiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJuYmYiOjE2NjYyOTk2NTUsImF1ZCI6IjgzMDY0NDU3MzY2LWViOG9xaWMwNjBnY2V1NHE0cXR1dXUzMml1N2wyZ3V0LmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwic3ViIjoiMTA4NDk2NzU5MzUyMjA0NzYzNDgzIiwiZW1haWwiOiJ0cmFjeS5sZXdpbkBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXpwIjoiODMwNjQ0NTczNjYtZWI4b3FpYzA2MGdjZXU0cTRxdHV1dTMyaXU3bDJndXQuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJuYW1lIjoiVHJheSBMZXdpbiIsInBpY3R1cmUiOiJodHRwczovL2xoMy5nb29nbGV1c2VyY29udGVudC5jb20vYS9BTG01d3UyeUtDT0swZW81MGVqUDZJNDBRcGkxWVpXZ2IzZmFMcHkwZS13R1dnPXM5Ni1jIiwiZ2l2ZW5fbmFtZSI6IlRyYXkiLCJmYW1pbHlfbmFtZSI6Ikxld2luIiwiaWF0IjoxNjY2Mjk5OTU1LCJleHAiOjE2NjYzMDM1NTUsImp0aSI6IjAwZmUwNmRiOTM1MDFmMDM2Zjc3ODljOWFhNTMwOTgwNzI0OGI5NWYifQ.ctejkZ4LbBsKOgUvV09jYA4LQHodI3V3LK7_Sbp02bElan4xIotDZ19oQ2DMl3nQSDKf1bXLwdm_ypkyye2FBCiCWAcNWvKbzWVW-h0CDciabV7WqWmctkALr9Zc4uU-04GUouPkU4Ep1w-zs-3_-ba7xRmJDxFECwxqLeb0AwScVC5qPbNVpAR9cXp_CgUz2tSpBMY0mZ469rXNKh5JwhFC72GnhdKW0Rfs5VCvRXY-Uu6TRSrV2NIY0auK8y39-BJY1eQAl7yjYHeSPWTHJrbDfMV-WeC4ZGjB4vh4uUqHeTSNWJ_6tJ2Wkr7rw-OHWavRjHAMEaMXReWN6uCFdw\",\n \"provider\": \"google\"\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/account/new-user-with-token","description":"Returns an OAuth accessToken which may be included in the header of future requests to other api endpoints. The access token is scoped to a single user
\nid_token - Id token issued by an Oauth provider. The Oauth provider domain (iss) must be registered in your ORE ID app registration
\naccount - user's unique account (Ore ID). This can be thought of the userID used to specify the user in future requests
\naccessToken - access_token which may be included in the header of future requests to other api endpoints
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","new-user-with-token"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"0d3a1eab-d0ab-4f18-8a05-27fbbd0b61c9","name":"New User With Token","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id_token\": \"eyJhbGc...\"\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/account/new-user-with-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"account\": \"ore123456789\",\n \"accessToken\": \"ey...\"\n}"}],"_postman_id":"9ad14572-b4dd-4c83-975b-46d2c5204734"},{"name":"Get Settings - Chains Config","id":"9e17c8c9-22cf-4ebc-bfba-fbc2ee486ba8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""}],"url":"service.oreid.io/api/services/config?type=chains","description":"Get the list of blockchain names and urls. This is the value used for the chainAccount parameter in several APIs.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","services","config"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) Type of configuration data. eg: type=chains will return information for all the chains
\n","type":"text/plain"},"key":"type","value":"chains"}],"variable":[]}},"response":[{"id":"b910bfb0-b864-46d6-8b26-4bdba993c36a","name":"Get Settings - Chains Config","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":""},{"key":"Content-Type","value":"application/json","disabled":true}],"url":{"raw":"service.oreid.io/api/services/config?type=chains","host":["service.oreid.io"],"path":["api","services","config"],"query":[{"key":"type","value":"chains"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 01:18:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"7b1-59sZJcsJL9xHCOYeVjfPYNmVwM8\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"values\": {\n \"chains\": [\n {\n \"network\": \"eos_main\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"9bdc4b43-b287-4e3b-abdd-a4039ca99589.gw.eosinfra.io\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n },\n {\n \"host\": \"eos.greymass.com\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n },\n {\n \"host\": \"api.cypherglass.com:443\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n },\n {\n \"host\": \"api.eosnewyork.io:443\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n }\n ]\n },\n {\n \"network\": \"eos_kylin\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"api-kylin.eosasia.one\",\n \"port\": \"443\",\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n },\n {\n \"host\": \"api-kylin.eoslaomao.com\",\n \"port\": \"443\",\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n }\n ]\n },\n {\n \"network\": \"eos_jungle\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"jungle.eosio.cr\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"e70aaab8997e1dfce58fbfac80cbbb8fecec7b99cf982a9444273cbc64c41473\"\n }\n ]\n },\n {\n \"network\": \"ore_main\",\n \"type\": \"ore\",\n \"hosts\": [\n {\n \"host\": \"ore.openrights.exchange\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"7900eaca71d5b213d3e1e15d54d98ad235a7a5b8166361be78e672edeeb2b47a\"\n }\n ]\n },\n {\n \"network\": \"ore_test\",\n \"type\": \"ore\",\n \"hosts\": [\n {\n \"host\": \"ore-staging.openrights.exchange\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"a6df478d5593b4efb1ea20d13ba8a3efc1364ee0bf7dbd85d8d756831c0e3256\"\n }\n ]\n },\n {\n \"network\": \"kylin-dsp-1.liquidapps.io\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"kylin-dsp-1.liquidapps.io\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n }\n ]\n },\n {\n \"network\": \"kylin-dsp-2.liquidapps.io\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"kylin-dsp-2.liquidapps.io\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"9e17c8c9-22cf-4ebc-bfba-fbc2ee486ba8"},{"name":"Get Settings - Chain Config","id":"f8a34be9-2104-4425-b2b9-b24261806fad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""}],"url":"service.oreid.io/api/services/config?type=chain&chainNetwork=eos_main","description":"Get the list of blockchain names and urls. This is the value used for the chainAccount parameter in several APIs.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","services","config"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) Type of configuration data. eg: type=chains will return information for all the chains
\n","type":"text/plain"},"key":"type","value":"chain"},{"key":"chainNetwork","value":"eos_main"}],"variable":[]}},"response":[{"id":"d5697a8b-9ce2-4a39-bbf8-0139d820fcec","name":"Get Settings - Chains Config","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":""},{"key":"Content-Type","value":"application/json","disabled":true}],"url":{"raw":"service.oreid.io/api/services/config?type=chains","host":["service.oreid.io"],"path":["api","services","config"],"query":[{"key":"type","value":"chains"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 01:18:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"7b1-59sZJcsJL9xHCOYeVjfPYNmVwM8\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"values\": {\n \"chains\": [\n {\n \"network\": \"eos_main\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"9bdc4b43-b287-4e3b-abdd-a4039ca99589.gw.eosinfra.io\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n },\n {\n \"host\": \"eos.greymass.com\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n },\n {\n \"host\": \"api.cypherglass.com:443\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n },\n {\n \"host\": \"api.eosnewyork.io:443\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906\"\n }\n ]\n },\n {\n \"network\": \"eos_kylin\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"api-kylin.eosasia.one\",\n \"port\": \"443\",\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n },\n {\n \"host\": \"api-kylin.eoslaomao.com\",\n \"port\": \"443\",\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n }\n ]\n },\n {\n \"network\": \"eos_jungle\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"jungle.eosio.cr\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"e70aaab8997e1dfce58fbfac80cbbb8fecec7b99cf982a9444273cbc64c41473\"\n }\n ]\n },\n {\n \"network\": \"ore_main\",\n \"type\": \"ore\",\n \"hosts\": [\n {\n \"host\": \"ore.openrights.exchange\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"7900eaca71d5b213d3e1e15d54d98ad235a7a5b8166361be78e672edeeb2b47a\"\n }\n ]\n },\n {\n \"network\": \"ore_test\",\n \"type\": \"ore\",\n \"hosts\": [\n {\n \"host\": \"ore-staging.openrights.exchange\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"a6df478d5593b4efb1ea20d13ba8a3efc1364ee0bf7dbd85d8d756831c0e3256\"\n }\n ]\n },\n {\n \"network\": \"kylin-dsp-1.liquidapps.io\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"kylin-dsp-1.liquidapps.io\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n }\n ]\n },\n {\n \"network\": \"kylin-dsp-2.liquidapps.io\",\n \"type\": \"eos\",\n \"hosts\": [\n {\n \"host\": \"kylin-dsp-2.liquidapps.io\",\n \"port\": 443,\n \"protocol\": \"https\",\n \"chainId\": \"5fff1dae8dc8e2fc4d5b23b2c7665c97f9e9d8edf2b6485a86ba311c25639191\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"f8a34be9-2104-4425-b2b9-b24261806fad"},{"name":"Add Permission","id":"60e0ed3e-bf15-4653-bb25-f450e981e914","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""}],"url":"service.oreid.io/api/account/add-permission?wallet-type=scatter&account=ore1sgvwcryd&permission=mypermnamexx&parent-permission=active&public-key=EOS85DVaEkeGwGJaE7GNcKBRu7T7VV61k7fqqHbA5Mf7VEL1kmmAR&chain-account=ore1sgvwcryd&chain-network=wax_test","description":"Add a public key to a user's existing OREID account. This is useful to track a user's blockchain keys. The eos-auth library will add a public key using this API if the user signs a transction with an EOS key stored in a user's wallet (e.g. Scatter). In this way, your app can help the user find his keys regardless of what wallet they are stored in. \nNote: If a permission with this name already exists, the transaction will fail.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","add-permission"],"host":["service.oreid.io"],"query":[{"description":{"content":"An optional string designating the wallet provider where the key is stored (if any) (must be a wallet supported by ORE ID e.g. 'scatter')
\n","type":"text/plain"},"key":"wallet-type","value":"scatter"},{"description":{"content":"(REQUIRED) The 12 character account name for the user.
\n","type":"text/plain"},"key":"account","value":"ore1sgvwcryd"},{"description":{"content":"(REQUIRED) A 12 character name (same naming rules as an EOS acccount name).
\n","type":"text/plain"},"key":"permission","value":"mypermnamexx"},{"description":{"content":"The parent permission (defaults to 'active')
\n","type":"text/plain"},"key":"parent-permission","value":"active"},{"description":{"content":"(REQUIRED)
\n","type":"text/plain"},"key":"public-key","value":"EOS85DVaEkeGwGJaE7GNcKBRu7T7VV61k7fqqHbA5Mf7VEL1kmmAR"},{"description":{"content":"(REQUIRED) The 12-character account name.
\n","type":"text/plain"},"key":"chain-account","value":"ore1sgvwcryd"},{"description":{"content":"(REQUIRED) A network nickname (eos_main, eos_kylin, eos_jungle, ore_main, ore_test) as listed in the 'network' in the Chains Config response
\n","type":"text/plain"},"key":"chain-network","value":"wax_test"}],"variable":[]}},"response":[{"id":"bed084bb-e5c2-4ebe-97e7-fce29fef2efb","name":"Add Permission","originalRequest":{"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""}],"url":{"raw":"service.oreid.io/api/account/add-permission?wallet-type=scatter&account=ore1sgvwcryd&permission=mypermnamexx&parent-permission=active&public-key=EOS85DVaEkeGwGJaE7GNcKBRu7T7VV61k7fqqHbA5Mf7VEL1kmmAR&chain-account=ore1sgvwcryd&chain-network=wax_test","host":["service.oreid.io"],"path":["api","account","add-permission"],"query":[{"key":"wallet-type","value":"scatter","description":"An optional string designating the wallet provider where the key is stored (if any) (must be a wallet supported by ORE ID e.g. 'scatter')"},{"key":"account","value":"ore1sgvwcryd","description":"(REQUIRED) The 12 character account name for the user."},{"key":"permission","value":"mypermnamexx","description":"(REQUIRED) A 12 character name (same naming rules as an EOS acccount name)."},{"key":"parent-permission","value":"active","description":"The parent permission (defaults to 'active')"},{"key":"public-key","value":"EOS85DVaEkeGwGJaE7GNcKBRu7T7VV61k7fqqHbA5Mf7VEL1kmmAR","description":"(REQUIRED)"},{"key":"chain-account","value":"ore1sgvwcryd","description":"(REQUIRED) The 12-character account name."},{"key":"chain-network","value":"wax_test","description":"(REQUIRED) A network nickname (eos_main, eos_kylin, eos_jungle, ore_main, ore_test) as listed in the 'network' in the Chains Config response"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"236"},{"key":"ETag","value":"W/\"ec-seCvdW6s7TnqzI9bCeuKrfAI0bg\""},{"key":"Date","value":"Sat, 20 Nov 2021 23:23:46 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"added key:EOS85DVaEkeGwGJaE7GNcKBRu7T7VV61k7fqqHbA5Mf7VEL1kmmAR for chainAccount:ore1sgvwcryd on chain:wax_test added to OREID account:ore1sgvwcryd as permission:mypermnamexx\"\n}"}],"_postman_id":"60e0ed3e-bf15-4653-bb25-f450e981e914"}],"id":"f0874d43-2c8a-4672-830e-ca233bb4d90a","_postman_id":"f0874d43-2c8a-4672-830e-ca233bb4d90a","description":""},{"name":"Browser","item":[{"name":"Browser: Authenticate User","id":"a5581a6c-a71c-4083-9a95-9fc8454be1e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"service.oreid.io/auth?app_access_token=access_token&provider=facebook&callback_url=https%3A%2F%2Fmysite.com%2Fauth&background_color=AADDFF&state=optional_string","description":"This URL is called from your application in the browser to Authenticate a user. You will need an app_access_token from the Get App Token api call.
\nFowards the browser to the ORE ID auth flow. The user will enter a PIN to create or unlock their account. Returns to your callback_url when completed.
\nIf there are errors, there will be information in query parameters on the callback_url
\nCommon Errors:
\ncallback_invalid: The callback_url is not listed in the callback URLs section of the Settings panel at https://oreid.io/developer/app-settings
\nView a complete list of the error codes here.
\n","urlObject":{"path":["auth"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) The access token received from calling the Get Access Token API.
\n","type":"text/plain"},"key":"app_access_token","value":"access_token"},{"description":{"content":"(REQUIRED) Either 'facebook', 'linkedin', 'github', 'google', 'twitch', 'twitter', 'phone', 'email' or others we support. If not provided, the user will be prompted with a UI to choose one of the supported providers.
\n","type":"text/plain"},"key":"provider","value":"facebook"},{"description":{"content":"(REQUIRED) The browser will redirect to this URL once the users sign in flow is completed. It must match one of the callback urls in the apps settings. Must be URL encoded
\n","type":"text/plain"},"key":"callback_url","value":"https%3A%2F%2Fmysite.com%2Fauth"},{"description":{"content":"A background color in hex (eg: 0022FF). This provides the ability to customize the background color of the web pages in the login flow.
\n","type":"text/plain"},"key":"background_color","value":"AADDFF"},{"description":{"content":"Any URL safe string (no special characters). It will be passed back as a parameter when the callback is called. You can use this to restore your websites state after the callback has been called.
\n","type":"text/plain"},"key":"state","value":"optional_string"}],"variable":[]}},"response":[],"_postman_id":"a5581a6c-a71c-4083-9a95-9fc8454be1e6"},{"name":"Browser: Logout","id":"2ad7c064-e276-4287-be58-0c906db05666","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"service.oreid.io/logout?app_id=appId&providers=all&callback_url=https%3A%2F%2Fmysite.com%2Flogout&state=optional_string","description":"This URL is called from your application in the browser to clear all login tokens in the users browser (on the service.oreid.io path). You will need your app_id.
\nReturns to your callback_url when completed. If the optional state param is provided, it will be returned on the callback.
\nIf there are errors, there will be information in query parameters on the callback
\nCommon Errors:
\ncallback_invalid: The callback_url is not listed in the callback URLs section of the Settings panel at https://oreid.io/developer/app-settings
\nView a complete list of the error codes here.
\n","urlObject":{"path":["logout"],"host":["service.oreid.io"],"query":[{"key":"app_id","value":"appId"},{"description":{"content":"(REQUIRED) Either 'all' or a comma-seperated list of one or more providers (e.g. 'facebook,google' or others we support.
\n","type":"text/plain"},"key":"providers","value":"all"},{"description":{"content":"(REQUIRED) The browser will redirect to this URL once the users logout is completed. It must match one of the callback urls in the apps settings. Must be URL encoded
\n","type":"text/plain"},"key":"callback_url","value":"https%3A%2F%2Fmysite.com%2Flogout"},{"description":{"content":"Any URL safe string (no special characters). It will be passed back as a parameter when the callback is called. You can use this to restore your websites state after the callback has been called.
\n","type":"text/plain"},"key":"state","value":"optional_string"}],"variable":[]}},"response":[{"id":"599f05ae-3890-431a-a933-6c110f472cb0","name":"Browser: Logout","originalRequest":{"method":"GET","header":[],"url":{"raw":"service.oreid.io/logout?app_id=appId&providers=all&callback_url=https%3A%2F%2Fmysite.com%2Flogout&state=optional_string","host":["service.oreid.io"],"path":["logout"],"query":[{"key":"app_id","value":"appId"},{"key":"providers","value":"all","description":"(REQUIRED) Either 'all' or a comma-seperated list of one or more providers (e.g. 'facebook,google' or others we support."},{"key":"callback_url","value":"https%3A%2F%2Fmysite.com%2Flogout","description":"(REQUIRED) The browser will redirect to this URL once the users logout is completed. It must match one of the callback urls in the apps settings. Must be URL encoded"},{"key":"state","value":"optional_string","description":"Any URL safe string (no special characters). It will be passed back as a parameter when the callback is called. You can use this to restore your websites state after the callback has been called."}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Next.js"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-store, must-revalidate"},{"key":"ETag","value":"\"25d6-RFf41hZjlji2ZDtiEmZGKeAM1Ak\""},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"9686"},{"key":"Date","value":"Sun, 21 Nov 2021 20:32:56 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"https://mysite.com/logout&state=optional_string"}],"_postman_id":"2ad7c064-e276-4287-be58-0c906db05666"},{"name":"Browser: Sign Transaction","id":"93039483-89e6-4250-aefa-c3af0e1c95b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""}],"url":"service.oreid.io/sign?account=mybcusername&allow_chain_account_selection=false&app_access_token=token&broadcast=true&callback_url=https%3A%2F%2Fmysite.com%2Fsign&chain_account=0xaccount1&chain_network=eth_ropsten&return_signed_transaction=true&state=optional_string&transaction=base64Transaction&multisig_chain_accounts=0xaccount2, 0xaccount3&provider=google&transaction_chain_account=0xaccount1","description":"This URL is called from your application in the browser to sign a transaction.
\nForwards the browser to ORE ID where the user will enter a PIN to sign the transaction.
\nThe browser will return to the callback URL when completed.
\nIf there are errors, they will show in the query parameters in the callback.
\nCommon Errors:
\ncallback_invalid: You need to make sure the callback is set and listed in the callback URLs section of the Settings panel at https://oreid.io/developer/app-settings
\nbad-param_app-access_token:
\nView a complete list of the error codes here.
\n","urlObject":{"path":["sign"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) The user's ORE ID account name. This is often the same as the chain_account but it does not have to be as the user can have more than one chain_account or may be different on different chains
\n","type":"text/plain"},"key":"account","value":"mybcusername"},{"description":{"content":"Allow user to choose an alternative chain account (and permission) during the signing process. This would allow the user to choose an account in an external wallet (e.g. Scatter) to sign with. The selected account would replace the chain_account and permission used to sign the transaction.
\n","type":"text/plain"},"key":"allow_chain_account_selection","value":"false"},{"description":{"content":"(REQUIRED) The access token received from calling the Get Access Token API.
\n","type":"text/plain"},"key":"app_access_token","value":"token"},{"description":{"content":"If true, the transaction will be submitted after being signed.
\n","type":"text/plain"},"key":"broadcast","value":"true"},{"description":{"content":"(REQUIRED) The browser will redirect to this URL once the users sign in flow is completed. It must match one of the callback urls in the apps settings. Must be URL encoded
\n","type":"text/plain"},"key":"callback_url","value":"https%3A%2F%2Fmysite.com%2Fsign"},{"description":{"content":"The blockchain account/address of the user signing the transaction.
\n","type":"text/plain"},"key":"chain_account","value":"0xaccount1"},{"description":{"content":"A network nickname (e.g. eos_main, eos_kylin, eos_jungle, eth_main, eth_ropsten) as listed in the 'network' in the Chains Config response
\n","type":"text/plain"},"key":"chain_network","value":"eth_ropsten"},{"description":{"content":"(Defaults to true) - If false, doesn’t return signed transaction object in results.
\n","type":"text/plain"},"key":"return_signed_transaction","value":"true"},{"description":{"content":"(Optional) Any URL safe string (no special characters). It will be passed back as a parameter when the callback is called. You can use this to restore your websites state after the callback has been called.
\n","type":"text/plain"},"key":"state","value":"optional_string"},{"description":{"content":"base64 encoded JSON of the transaction.
\n","type":"text/plain"},"key":"transaction","value":"base64Transaction"},{"description":{"content":"(Optional) A comma-seperated list of chain accounts that should add signatures to a multisig transaction. ORE ID must have access to the private keys for these accounts
\n","type":"text/plain"},"key":"multisig_chain_accounts","value":"0xaccount2, 0xaccount3"},{"description":{"content":"(Optional) Override to specify how a user should authenticate before signing the transaction. Defaults to user's primary login type
\n","type":"text/plain"},"key":"provider","value":"google"},{"description":{"content":"(Optional) The target of the transaction (aka 'from' account)- usually only different from chainAccount for multisig transactions
\n","type":"text/plain"},"key":"transaction_chain_account","value":"0xaccount1"}],"variable":[]}},"response":[],"_postman_id":"93039483-89e6-4250-aefa-c3af0e1c95b3"}],"id":"2c413817-7d16-4741-ae19-35d58533a68b","_postman_id":"2c413817-7d16-4741-ae19-35d58533a68b","description":""},{"name":"Passwordless Login","item":[{"name":"Passwordless Login - Send Code","id":"74e2ad19-f663-4943-97b4-a16645dbbd64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""}],"url":"service.oreid.io/api/account/login-passwordless-send-code?provider=email&email=myemail@email.com","description":"There are two ways of performing a passwordless login using an email or phone number.
\nThe most common way is to use our auth endpoint and use either 'phone' or 'email' as the provider. The auth flow will send the user an email or sms message, and prompt them to enter the returned code. If the code is valid, the users account will be created and they will be logged in.
\nThe second way is to call one endpoint to send a code to the user, and another to verify the code. Then once you have the code you can call our auth endpoint to authenticate using email or phone and the code. You would provide the UI for getting the users phone/email and for verifying the code.
\nThis endpoint will send and email or sms message to the provided email/phone. The email or sms will contain a code to use to verify and authenticate in ORE ID.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","login-passwordless-send-code"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) Either 'phone' or 'email'
\n","type":"text/plain"},"key":"provider","value":"email"},{"description":{"content":"(REQUIRED) Users phone or email
\n","type":"text/plain"},"key":"email","value":"myemail@email.com"}],"variable":[]}},"response":[{"id":"ce15fa8e-a3b7-4938-91fc-0cf1b1f80beb","name":"Passwordless Login - Send Code","originalRequest":{"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""}],"url":{"raw":"service.oreid.io/api/account/login-passwordless-send-code?provider=email&email=myemail@email.com","host":["service.oreid.io"],"path":["api","account","login-passwordless-send-code"],"query":[{"key":"provider","value":"email"},{"key":"email","value":"myemail@email.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 23:19:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"41-qSEZnqjb6zz9JKyp+wuWzClXXx4\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"sent login code to myemail@email.com\"\n}"}],"_postman_id":"74e2ad19-f663-4943-97b4-a16645dbbd64"},{"name":"Passwordless Login - Verify Code","id":"9cfa1eec-d54b-42f4-97c0-0b8eb324af5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"api-key","value":"","description":"(REQUIRED) The api-key for your application on ORE ID.
\n","type":"text"}],"url":"service.oreid.io/api/account/login-passwordless-verify-code?email=myemail@email.com&provider=email&code=511186","description":"This will verify a code entered by the user on your website.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","account","login-passwordless-verify-code"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) Either 'phone' or 'email'
\n","type":"text/plain"},"key":"email","value":"myemail@email.com"},{"description":{"content":"(REQUIRED) Users phone or email
\n","type":"text/plain"},"key":"provider","value":"email"},{"description":{"content":"(REQUIRED) Code sent by sms or email.
\n","type":"text/plain"},"key":"code","value":"511186"}],"variable":[]}},"response":[],"_postman_id":"9cfa1eec-d54b-42f4-97c0-0b8eb324af5d"},{"name":"Passwordless Login - Authenticate User","id":"0f9f2a8f-ec2c-4114-b905-ba42ab7072ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""}],"url":"service.oreid.io/auth?provider=email&callback_url=https%3A%2F%2Fmysite.com%2Fauth&background_color=AADDFF&state=optional_string&email=myemail@email.com&phone=+12223334444&code=511186","description":"This is the same endpoint as Authenticating a User, but with the additional params for the email or phone, and the verification code. You will need an app_access_token from the Get App Token api call.
\nCommon Errors:
\ncallback_invalid: The callback_url is not listed in the callback URLs section of the Settings panel at https://oreid.io/developer/app-settings
\ninvalid_login_code: Login code expired or mistyped.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["auth"],"host":["service.oreid.io"],"query":[{"description":{"content":"(REQUIRED) Either 'phone' or 'email'
\n","type":"text/plain"},"key":"provider","value":"email"},{"description":{"content":"(REQUIRED) The browser will redirect to this URL once the users sign in flow is completed. It must match one of the callback urls in the apps settings. Must be URL encoded
\n","type":"text/plain"},"key":"callback_url","value":"https%3A%2F%2Fmysite.com%2Fauth"},{"description":{"content":"A background color in hex (eg: 0022FF). This provides the ability to customize the background color of the web pages in the login flow.
\n","type":"text/plain"},"key":"background_color","value":"AADDFF"},{"description":{"content":"Any URL safe string (no special characters). It will be passed back as a parameter when the callback is called. You can use this to restore your websites state after the callback has been called.
\n","type":"text/plain"},"key":"state","value":"optional_string"},{"description":{"content":"If provider=email, include the users email.
\n","type":"text/plain"},"key":"email","value":"myemail@email.com"},{"description":{"content":"If provider=phone, include the users phone. Add the + and country code. If not present, our code will make a best effort to add it.
\n","type":"text/plain"},"key":"phone","value":"+12223334444"},{"description":{"content":"(REQUIRED) Pass the code received by email or sms message.
\n","type":"text/plain"},"key":"code","value":"511186"}],"variable":[]}},"response":[],"_postman_id":"0f9f2a8f-ec2c-4114-b905-ba42ab7072ca"}],"id":"c3549045-fc5e-4062-a453-d1fa058ce3fd","description":"Passwordless Login allows a user to create an account with only an email or phone number - and no password. ORE ID confirms that the user has access to that email or phone by sending a confirmation code. Upon confirmation, the user gets an ORE ID access token in thier browser cache. When the access token expires (in 30 days), the user will have to authorize again via the confirmation code flow.
\n","event":[{"listen":"prerequest","script":{"id":"9ea4f18c-a6a5-4005-8305-e906272464f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a82623ce-cea0-421f-8d24-ff4af14d9649","type":"text/javascript","exec":[""]}}],"_postman_id":"c3549045-fc5e-4062-a453-d1fa058ce3fd"},{"name":"Enterprise Accounts","item":[{"name":"Custodial - Create Account","id":"c3709139-724f-482a-92e4-0f6b66b4cdb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"access_token\": \"ya29.a0AVA9y1uCpraCxN1ZTXYsmf908Gi2gWNm8WbEg23iSrsZ42Mq1wnFC9IPNJxzKvjieyYvsyOTrk7ahJRtfm96FNyEEzp4U75FmMh46tgcCSfkIn1rCdqPrNe6aEQ4gwPi9NujKy2dujpqGdm7QldEZjh-XjJIaCgYKATASAQASFQE65dr8Mbzes2tWkjFXVHYMWV4c_w0163\",\n \"access_token_provider\": \"google\",\n \"account_type\": \"native\",\n \"user_password\": \"2233\",\n \"name\": \"Tray Aikon Test\",\n \"user_name\": \"traytest\",\n \"email\": \"tray+test0917b@aikon.com\",\n \"picture\": \"https://notavalidurl.io//nothing.jpg\",\n \"phone\": \"+12223334444\",\n \"email_verified\": true,\n \"is_test_user\": true\n}"},"url":"service.oreid.io/api/custodial/new-user","description":"Create a custodial account. Returns a 12 digit EOS account name (user’s ORE account name)
\nOptionally accepts id_token - A JWT OAuth token issued by a known OAuth provider (e.g. Google).\nIf an id_token is provided, the user will be created from the data in the token and no other user parameters (e.g. name, email) need to be included - they will all be extracted from the OAuth token. \nHowever, if a param is provided (e.g. user_Name), it will be used instead of the corresponding value in the Id Token - this allows you to override one or more values.\nImportant: In order to use an external id_token, your ORE ID App Registration must be configured to use it. \nAdditionally, Auth0 is an authorized OAuth provider. Tokens issues by your Auth0 domain can be used here as long as your Auth0 domain is registered in your ORE ID App Registration.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","custodial","new-user"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"c46744f7-d236-442d-8c75-546a8affcdb3","name":"Custodial - Create Account","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Q Test\",\n \"user_name\": \"jqtest\",\n \"email\": \"email@example.com\",\n \"picture\": \"https://example.com/media/user.1234.jpg\",\n \"user_password\": \"Password123!\",\n \"phone\": \"+12223334444\",\n \"account_type\": \"native\"\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/custodial/new-user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"200"},{"key":"ETag","value":"W/\"c8-1czV53eIllBPxRg/c+jUVeXhzGc\""},{"key":"Date","value":"Wed, 30 Jun 2021 16:32:49 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"8c4aba8cd1b7\",\n \"accountName\": \"ore1s21pymgr\"\n}"}],"_postman_id":"c3709139-724f-482a-92e4-0f6b66b4cdb2"},{"name":"Custodial - Create Chain Account For User","id":"351535f4-a5ce-4600-a738-e9667d907044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_name\": \"ore1prgcasmw\",\n \"account_type\": \"native\",\n \"chain_network\": \"ore_main\",\n \"user_password\": \"2233\"\n}\n"},"url":"service.oreid.io/api/custodial/new-chain-account","description":"Create an additional account on a blockchain for an existing custodial account. Returns the newly created chain account name.
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","custodial","new-chain-account"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"d2ea114d-6f51-4223-937d-8885f6b5927b","name":"Custodial - Create Chain Account For User","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_name\": \"ore1s21pymgr\",\n \"account_type\": \"native\",\n \"chain_network\": \"eth_ropsten\",\n \"user_password\": \"Password123!\"\n}\n"},"url":"service.oreid.io/api/custodial/new-chain-account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"88"},{"key":"ETag","value":"W/\"58-FtwGz7qWmQM6gRELV28C98ubEmM\""},{"key":"Date","value":"Wed, 30 Jun 2021 17:04:47 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"687d17c5ad5f\",\n \"chainAccount\": \"0xaeb27c5e5b437f04a9f4a76d4a08526082064793\"\n}"},{"id":"921770ce-cf01-4297-aed0-52918f9148cc","name":"Custodial - Create Chain Account For User Gae","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_name\": \"ore1s21pymgr\",\n \"account_type\": \"native\",\n \"chain_network\": \"eth_ropsten\",\n \"user_password\": \"Password123!\"\n}\n"},"url":"service.oreid.io/api/custodial/new-chain-account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"88"},{"key":"ETag","value":"W/\"58-FtwGz7qWmQM6gRELV28C98ubEmM\""},{"key":"Date","value":"Wed, 30 Jun 2021 17:04:47 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"687d17c5ad5f\",\n \"chainAccount\": \"0xaeb27c5e5b437f04a9f4a76d4a08526082064793\"\n}"}],"_postman_id":"351535f4-a5ce-4600-a738-e9667d907044"},{"name":"Custodial - Sign Transaction","id":"7595a6d2-ac8d-48a7-a3c0-493f02083195","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1r1xzh1p3\",\n \"chain_account\": \"ore1r1xzh1p3\",\n \"chain_network\": \"eos_kylin\",\n \"transaction\": \"eyJhY2NvdW50IjoiZGVtb2FwcGhlbGxvIiwibmFtZSI6ImhpIiwiYXV0aG9yaXphdGlvbiI6W3siYWN0b3IiOiJvcmUxcjF4emgxcDMiLCJwZXJtaXNzaW9uIjoiYXBwZGVtb2N1c3RvIn1dLCJkYXRhIjp7InVzZXIiOiJvcmUxcjF4emgxcDMifX0=\",\n \"wallet_password\": \"...\",\n \"wallet_password_encrypted\": \"...\"\n}\n"},"url":"service.oreid.io/api/custodial/sign","description":"Sign a transaction with the user's chainAccount. Returns a Base4 encoded signed Transaction and/or transaction ID
\naccount - (Required) The 12-character ORE account name of the user.
\nchain_account - (Required) The 12-character account name on the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\ntransaction - Base64 encoded JSON of the transaction
\nsigned_transaction - Base64 encoded JSON of a transaction that already includes at least one signature (usually in the 'raw' format of a transaction ready to send to the chain)
\nuser_password (Required) The user’s password (the same password as used when creating the user’s account - aka user PIN)
\nbroadcast - (Optional) If true, the transaction will be submitted after being signed.
\nreturn_signed_transaction - (Defaults to true) - If false, doesn’t return signed transaction object in results.
\nexpire_seconds - (Optional) - Override the default transaction timeout. Can be up to 3000 (5 mins). Useful if your app takes a while to send transaction to have it signed (or if the network is congested)
\nmultisig_chain_accounts - Comma seperated list of chain accounts for which ORE ID should add signatures to the transaction. Should NOT include the user's account as specified above in chain_account. Note: ORE ID must be provided with the private keys for additional signer accounts as part of the app configuration
\nsigned_transaction - Base64 encoded signed transaction - in the 'raw' format ready to be transmitted to the chain (if broadcast=true, it will have already been submitted)
\ntransaction_id - Transaction ID (if available) - can be used to look-up the transaction on a block explorer
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","custodial","sign"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"80602863-0d6c-45d3-adc2-889bf4ebe540","name":"Custodial - Sign Transaction","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1r1xzh1p3\",\n \"broadcast\": true,\n \"chain_account\": \"ore1pkiwe55w\",\n \"chain_network\": \"eos_kylin\",\n \"transaction\": \"eyJhY2NvdW50IjoiZGVtb2FwcGhlbGxvIiwibmFtZSI6ImhpIiwiYXV0aG9yaXphdGlvbiI6W3siYWN0b3IiOiJvcmUxcjF4emgxcDMiLCJwZXJtaXNzaW9uIjoiYXBwZGVtb2N1c3RvIn1dLCJkYXRhIjp7InVzZXIiOiJvcmUxcjF4emgxcDMifX0=\",\n \"user_password\": \"3344\"\n}\n"},"url":"service.oreid.io/api/transaction/sign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Aug 2020 19:28:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"228"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"e4-/WUDk3RmMhdGg5QQujs0tZNMle0\""},{"key":"Via","value":"1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"signed_transaction\": \"W3sic2VyaWFsaXplZFRyYW5zYWN0aW9uIjoiMSIsInNpZ25hdHVyZXMiOiIyIiwidHJhbnNhY3Rpb25JZCI6IjMifSxbMTAzLDE3Miw0NSw5NSwxNDgsOTIsMTQsNDcsMTE2LDI1MywwLDAsMCwwLDEsNjQsOTksODQsMTczLDg2LDY3LDE2NSw3NCwwLDAsMCwwLDAsMCwxMjgsMTA3LDEsNDgsMTA2LDEwNCwxOTEsMTM1LDI3LDIxMiwxNjUsNjQsNTEsMjE0LDEzNiw3NCwxNDksMTA2LDUzLDgsNDgsMTA2LDEwNCwxOTEsMTM1LDI3LDIxMiwxNjUsMF0sWyI0Il0sImRiZWIzZWE2OTQ0YjkwODY5ZTBlYTQxM2RkOWUyZmI2YmUxNTFiZGYxOGYzNWQ2NTY4MTY1ZjVjNDZjYmExNTkiLCJTSUdfSzFfSzhYS0E4dlF5a1ZVdkpyaFN2blBRdkQ0ODhWN1ZCeDlwclBjQ1B3alBQS0dNV05STWlWeVZxQ1ZVUFdwckZTaFhoVWF3eVI5Z1ZqaUdSZzZOWE00WVRwc29SZ1hSMyJd\",\n \"process_id\": \"3bf0cdf73c7e\"\n}\n"}],"_postman_id":"7595a6d2-ac8d-48a7-a3c0-493f02083195"},{"name":"Custodial - Sign String","id":"6f53c297-b707-47aa-bdc8-0ae355a27739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"0x...\",\n\t\"chain_network\": \"eth_goerli\",\n\t\"chain_account\": \"0x...\",\n \"string_to_sign\": \"something to sign\",\n \"sign_method\": \"ethereum.personal-sign\",\n \"user_password\": \"...\",\n \"user_password_encrypted\": \"...\"\n}\n"},"url":"service.oreid.io/api/custodial/sign-string","description":"Sign a string with the user's chainAccount. Returns a Base4 encoded signed Transaction and/or transaction ID
\naccount - (Required) The 12-character ORE account name of the user.
\nchain_account - (Required) The 12-character account name on the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\nstring_to_sign - (Required) The actual string to be signed. This could be a transaction, a structured string, or any arbitrary string.
\nsign_method - (Optional) For Ethereum and Ethereum Virtual Machine transactions, allows for signing transaction metadata. To sign an EIP-712 compatible string, select sign_typed_data.
Enum: personal_sign, sign_typed_data, eth_sign (deprecated)
user_password - (Optional) The user’s password (the same password as used when creating the user’s account - aka user PIN). Must be included if the user_password_encrypted is not included.
user_password_encrypted - (Optional) The user’s encrypted password (the same password as used when creating the user’s account - aka user PIN). Must be included if the user_password is not included.
signed_transaction - Base64 encoded signed transaction - in the 'raw' format ready to be transmitted to the chain (if broadcast=true, it will have already been submitted)
\ntransaction_id - Transaction ID (if available) - can be used to look-up the transaction on a block explorer
\nView a complete list of the error codes
\n\n","urlObject":{"path":["api","custodial","sign-string"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"a7974553-da6e-4899-b666-688c6859304a","name":"Custodial - Sign String","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1tky1zwwe\",\n\t\"chain_network\": \"eos_kylin\",\n\t\"chain_account\": \"ore1tky1zwwe\",\n \"string_to_sign\": \"something to sign\",\n \"user_password\": \"2233\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/custodial/sign-string"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Aug 2020 19:28:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"228"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"e4-/WUDk3RmMhdGg5QQujs0tZNMle0\""},{"key":"Via","value":"1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"signed_transaction\": \"W3sic2VyaWFsaXplZFRyYW5zYWN0aW9uIjoiMSIsInNpZ25hdHVyZXMiOiIyIiwidHJhbnNhY3Rpb25JZCI6IjMifSxbMTAzLDE3Miw0NSw5NSwxNDgsOTIsMTQsNDcsMTE2LDI1MywwLDAsMCwwLDEsNjQsOTksODQsMTczLDg2LDY3LDE2NSw3NCwwLDAsMCwwLDAsMCwxMjgsMTA3LDEsNDgsMTA2LDEwNCwxOTEsMTM1LDI3LDIxMiwxNjUsNjQsNTEsMjE0LDEzNiw3NCwxNDksMTA2LDUzLDgsNDgsMTA2LDEwNCwxOTEsMTM1LDI3LDIxMiwxNjUsMF0sWyI0Il0sImRiZWIzZWE2OTQ0YjkwODY5ZTBlYTQxM2RkOWUyZmI2YmUxNTFiZGYxOGYzNWQ2NTY4MTY1ZjVjNDZjYmExNTkiLCJTSUdfSzFfSzhYS0E4dlF5a1ZVdkpyaFN2blBRdkQ0ODhWN1ZCeDlwclBjQ1B3alBQS0dNV05STWlWeVZxQ1ZVUFdwckZTaFhoVWF3eVI5Z1ZqaUdSZzZOWE00WVRwc29SZ1hSMyJd\",\n \"process_id\": \"3bf0cdf73c7e\"\n}\n"}],"_postman_id":"6f53c297-b707-47aa-bdc8-0ae355a27739"},{"name":"Custodial - Change Password","id":"6c72ba32-56ac-4462-83cc-41519c186177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"api-key","type":"text","value":""},{"key":"service-key","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1qctfkfhw\",\n\t\"current_password\": \"3322\",\n \"new_password\": \"2233\"\n}\n"},"url":"service.oreid.io/api/custodial/change-password","description":"Sign a transaction for a custodial account\n
account - (Required) The 12-character ORE account name of the user signing the transaction.
\nchain_account - (Required) The 12-character account name associated with the transaction (the transaction actor) for the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\ntransaction - (Required) Base64 encoded JSON of the transaction.
\nbroadcast - If true, the transaction will be submitted after being signed.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\nuser_password (Required) The user’s password (the same password as used when creating the user’s record aka the walletPassword - aka user PIN)
\nreturn_signed_transaction - (Defaults to true) - If false, doesn’t return signed transaction object in results.
\nsigned_transaction - a base64 encoded JSON object of the transaction with a signature block attached
\ntransaction_id - (string) the transaction id after being broadcast to the chain - will only be set if broadcast = true
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","custodial","change-password"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c72ba32-56ac-4462-83cc-41519c186177"},{"name":"Custodial - Migrate Account","id":"0b2c88dc-7b55-4479-9175-18163a95fc38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"api-key","type":"text","value":""},{"key":"service-key","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1pkiwe55w\",\n \"chain_account\": \"ore1pkiwe55w\",\n \"chain_network\": \"eos_kylin\",\n \"user_password\": \"2233\",\n \"to_type\": \"native\"\n}\n"},"url":"service.oreid.io/api/custodial/migrate-account","description":"Migrate a user's custodial account type (eg from virtual to native)\n
account - (Required) The 12-character ORE account name of the user.
\nchain_account - (Required) The 12-character account name on the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\nto_type - must be 'native'. Note: 'virtual' will be supported in the future
\nuser_password (Required) The user’s password (the same password as used when creating the user’s account - aka user PIN)
\naccount - Usually the same as the chain_account specified in the request but may be different it the account name is not available on the target chain network
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","custodial","migrate-account"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b2c88dc-7b55-4479-9175-18163a95fc38"}],"id":"eff54202-abd1-4f0c-93d1-237eb660fe27","description":"Enterprise Accounts is a feature of OREID Enterprise. It allows developers to manage the account and password on behalf of the user.
\n","event":[{"listen":"prerequest","script":{"id":"78789ad7-71b9-4d59-b31b-662a5b0deca3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2bdf1196-b1db-44d5-a738-a4b7db48e4a7","type":"text/javascript","exec":[""]}}],"_postman_id":"eff54202-abd1-4f0c-93d1-237eb660fe27"},{"name":"Chain","item":[{"name":"Chain Get Account - Kylin","id":"164d4d9d-0f8a-4a7c-bb19-46e7e8c2dc85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"account_name\": \"demoapphello\"}"},"url":"https://api.kylin.alohaeos.com:443/v1/chain/get_account","description":"Get information about an an account on the Kylin test net. You need to include the account_name in the body of the request.
\nView a complete list of the error codes here.
\n","urlObject":{"protocol":"https","port":"443","path":["v1","chain","get_account"],"host":["api","kylin","alohaeos","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"164d4d9d-0f8a-4a7c-bb19-46e7e8c2dc85"},{"name":"Chain History Get Transaction - Kylin","id":"bff543e3-e54a-42bd-99b2-8e3f165e2326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\"id\": \"fa7fd895ef81d23c8225ce22cb6d8d18253f512528f632676668a64d836c8e29\", \"block_num_hint\":91545877}"},"url":"https://api.kylin.alohaeos.com:443/v1/history/get_transaction","description":"Get information about an an account on the Kylin test net. You need to include the account_name in the body of the request.
\nView a complete list of the error codes here.
\n","urlObject":{"protocol":"https","port":"443","path":["v1","history","get_transaction"],"host":["api","kylin","alohaeos","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bff543e3-e54a-42bd-99b2-8e3f165e2326"},{"name":"Chain History Get Transaction - EOS Main","id":"2290d2f1-b832-40d3-a8e4-ff41f5ed31f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"account_name\": \"demoapphello\"}"},"url":"https://api.kylin.alohaeos.com:443/v1/chain/get_account","description":"Get information about an an account on the Kylin test net. You need to include the account_name in the body of the request.
\nView a complete list of the error codes here.
\n","urlObject":{"protocol":"https","port":"443","path":["v1","chain","get_account"],"host":["api","kylin","alohaeos","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2290d2f1-b832-40d3-a8e4-ff41f5ed31f9"}],"id":"534de8fa-4f85-43d0-9fc6-d2945abf872f","_postman_id":"534de8fa-4f85-43d0-9fc6-d2945abf872f","description":""},{"name":"Token","item":[{"name":"Token - Airdrop","id":"26d3253c-fd27-452d-8396-222d2717c5d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":"{{service_key_airdrop}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \".1\",\n \"symbol\": \"DEMO\",\n \"chain_account\": \"proppropprop\",\n \"chain_network\": \"eos_kylin\",\n \"reason\": \"aidrop bonus\"\n}"},"url":"service.oreid.io/api/token/airdrop","description":"Send your tokens to an account on the chain. Returns the transaction Id of the transfer.\nThe token to be sent and the account to send from (aka 'Funding Account') must be pre-defined in the ORE ID app registration portal (oreid.io/developer). The total amount of tokens that can be transferred every day is capped.
\namount - (Required) - A string representing the quantity of tokens to send (e.g. '.000001234'). The unit depends on the token. For chain currency (e.g. EOS, Eth, Algos) the unit is the default for the chain for transfers (e.g. for Eth = WEI, for Algos = microAlgos, etc.)
\nsymbol - (Required) - The symbol name of the token to be sent. The token must already be defined in the ORE ID app registration (oreid.io/developer)
\nchain_account - (Required) - The account name on the chain to send the tokens to. This account does not need to be managed by ORE ID - it can be any valid chain account/address.
\nchain_network - (Required) - eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\nreason - (Optional) - A short string describing the reason for the airdrop - this will be sent to the chain as the transfer memo (if supported by chain)
\ntransactionId - Transaction ID (if available) - can be used to look-up the transaction on a block explorer
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","token","airdrop"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"d8372344-c07e-4cf1-b7a8-6d91759e5c11","name":"Token - Airdrop","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":"{{service_key_airdrop}}","description":"(REQUIRED) - A service key that is authorized for airdrops. See Funding Account on oreid.io/developer"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chain_account\": \"proppropprop\",\n \"symbol\": \"DEMO\",\n \"amount\": \"1.0\",\n \"chain_network\": \"eos_kylin\",\n \"reason\": \"aidrop bonus\"\n}"},"url":"service.oreid.io/api/token/airdrop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"111"},{"key":"ETag","value":"W/\"6f-1odbdceBo5CqyhhaB1lp/l4/Y2Y\""},{"key":"Date","value":"Sat, 03 Oct 2020 00:02:20 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"85254a6767bc\",\n \"transactionId\": \"5e03ea91b33534afbe42e5601b7a56cfa62dca3d70c5e5d42585a2ad6e36b4a4\"\n}"}],"_postman_id":"26d3253c-fd27-452d-8396-222d2717c5d2"},{"name":"Token - Transfer","id":"ed7c52b0-7e60-42c6-834a-46025ad5e33e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":"{{service_key_airdrop}}","description":"(REQUIRED) - A service key that is authorized for airdrops. See Funding Account on oreid.io/developer
\n"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"1.0\",\n \"symbol\": \"DEMO\",\n \"chain_account\": \"proppropprop\",\n \"chain_network\": \"eos_kylin\",\n \"funding_account\": \"proppropprop\"\n}"},"url":"service.oreid.io/api/token/airdrop","description":"Send tokens to an account on the chain. Returns the transaction Id of the transfer.\nThe token will be sent from funding_account. The total amount of tokens that can be transferred every day is capped.
\namount - (Required) - A string representing the quantity of tokens to send (e.g. '.000001234'). The unit depends on the token. For chain currency (e.g. EOS, Eth, Algos) the unit is the default for the chain for transfers (e.g. for Eth = WEI, for Algos = microAlgos, etc.)
\nsymbol - (Required) - The symbol name of the token to be sent. The token must already be defined in the ORE ID app registration (oreid.io/developer)
\nchain_account - (Required) - The account name on the chain to send the tokens to. This account does not need to be managed by ORE ID - it can be any valid chain account/address.
\nchain_network - (Required) - eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\nfunding_account - (Required) - The account name on the chain to send tokens from.
\ntransactionId - Transaction ID (if available) - can be used to look-up the transaction on a block explorer
\nView a complete list of the error codes here.
\n","urlObject":{"path":["api","token","airdrop"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"3785a935-d05a-46f1-aca9-351c8fb07349","name":"Token - Transfer","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":"{{service_key_airdrop}}","description":"(REQUIRED) - A service key that is authorized for airdrops. See Funding Account on oreid.io/developer"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chain_account\": \"proppropprop\",\n \"symbol\": \"DEMO\",\n \"amount\": \"1.0\",\n \"chain_network\": \"eos_kylin\",\n \"funcding_account\": \"your.account\",\n}"},"url":"service.oreid.io/api/token/airdrop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"111"},{"key":"ETag","value":"W/\"6f-1odbdceBo5CqyhhaB1lp/l4/Y2Y\""},{"key":"Date","value":"Sat, 03 Oct 2020 00:02:20 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"5e03ea91b33534afbe42e5601b7a56cfa62dca3d70c5e5d42585a2ad6e36b4a4\"\n}"}],"_postman_id":"ed7c52b0-7e60-42c6-834a-46025ad5e33e"}],"id":"40052a75-dc21-4edc-934a-a9f1460c81ea","_postman_id":"40052a75-dc21-4edc-934a-a9f1460c81ea","description":""},{"name":"Transaction","item":[{"name":"Transaction - Can auto-sign","id":"541af760-c381-4ecc-8866-686fc3aa530d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"description":"(OPTIONAL) The service account key for ORE ID Enterprise
\n","key":"service-key","type":"text","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1pcjp511v\",\n\t\"chain_network\": \"eos_kylin\",\n\t\"chain_account\": \"ore1pcjp511v\",\n \"transaction\": \"eyJhY2NvdW50IjoiZGVtb2FwcGhlbGxvIiwibmFtZSI6ImhpIiwiYXV0aG9yaXphdGlvbiI6W3siYWN0b3IiOiJvcmUxcGNqcDUxMXYiLCJwZXJtaXNzaW9uIjoiYXBwZGVtb2FwcGxpIn1dLCJkYXRhIjp7InVzZXIiOiJvcmUxcGNqcDUxMXYifX0=\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/can-auto-sign","description":"Checks whether a transaction can be signed (via Custodial - Sign Transaction) without requiring user intervention. A transaction can be auto-signed if the user has previously authorized auto-sign for a specific transaction contract/action (while signing a similar transaction) and if those auto-sign credentials have not yet expired. If autoSignCredentialsExist is true, then the transaction can be signed by calling Custodial - Sign Transaction and including auto_sign=true param. This endpoint also let's you know if the user can authorized auto-sign for this type of transaction (canCreateAutoSignCredentials).
\naccount - (Required) The 12-character ORE account name of the user signing the transaction.
\nchain_account - (Required) The 12-character account name associated with the transaction (the transaction actor) for the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\ntransaction - (Optional) Base64 encoded JSON of the transaction.
\nsigned_transaction - (Optional) Base64 encoded JSON of a transaction that already includes at least one signature.
\nNote: Either transaction or signed_transaction must be provided (but not both)
\nautoSignCredentialsExist - (boolean) Whether the user has autorized auto-sign for a similar transaction (all the same contract actions) and the auto-sign credentials have not yet expired
\ncanCreateAutoSignCredentials - (boolean) Whether the user is allowed to choose 'Use Auto-Sign for future transactions of this type' on the Sign Transaction screen
\nmaxAutoSignValidForInSeconds - (Integer) The maxiumum time that an auto-sign credential can exist for this type of transaction before expiring. Useful for letting a user know how long an auto-sign authorization will last for
\nerrorCode - (string) 'autoSignCheckFailed'
\nerrorMessage - (string) Detailed message(s) detailing which actions are enabled (or disallowed) for auto-sign
\n","urlObject":{"path":["api","transaction","can-auto-sign"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"4cbc5ef3-3191-478b-8c90-1556d65fb163","name":"Can Auto Sign","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"","type":"text","description":"(REQUIRED) The api-key for your application on ORE ID."},{"key":"service-key","value":"","description":"(OPTIONAL) The service account key for ORE ID Enterprise","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1pcjp511v\",\n\t\"chain_network\": \"eos_kylin\",\n\t\"chain_account\": \"ore1pcjp511v\",\n \"transaction\": \"eyJhY2NvdW50IjoiZGVtb2FwcGhlbGxvIiwibmFtZSI6ImhpIiwiYXV0aG9yaXphdGlvbiI6W3siYWN0b3IiOiJvcmUxcGNqcDUxMXYiLCJwZXJtaXNzaW9uIjoiYXBwZGVtb2FwcGxpIn1dLCJkYXRhIjp7InVzZXIiOiJvcmUxcGNqcDUxMXYifX0=\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/can-auto-sign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"autoSignCredentialsExist\": false,\n \"canCreateAutoSignCredentials\": false,\n \"maxAutoSignValidForInSeconds\": 36000\n}"}],"_postman_id":"541af760-c381-4ecc-8866-686fc3aa530d"},{"name":"Transaction - Compose Action","id":"6fd81e5a-60d4-4465-b169-ec204a21ad96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chain_network\": \"eth_ropsten\",\n \"chain_action_type\": \"ValueTransfer\",\n \"action_params\": \"ewogICAgICAidG9BY2NvdW50TmFtZSI6ICIweDI3MTA1MzU2RjZDMWVkZTBlOTIwMjBlNjIyNUU0NkRDMUY0OTZiODEiLAogICAgICAiYW1vdW50IjogIi4wMDAwMDAwMDAxIiwKICAgICAgInByZWNpc2lvbiI6IDE4LAogICAgICAic3ltYm9sIjogImV0aGVyIgp9\"\n}\n"},"url":"service.oreid.io/api/transaction/compose-action","description":"Compose a transaction action body for a well-defined type of transaction.
\namount - (Required) - A string representing the quantity of tokens to send (e.g. '.000001234'). The unit depends on the token. For chain currency (e.g. EOS, Eth, Algos) the unit is the default for the chain for transfers (e.g. for Eth = WEI, for Algos = microAlgos, etc.)
\nsymbol - (Required) - The symbol name of the token to be sent. The token must already be defined in the ORE ID app registration (oreid.io/developer)
\nchain_action_type - (Required) - A well-defined type of chain action. All chains support ValueTransfer and TokenTransfer. Each chain also supports chain-specific action types as defined in ChainJs.
\nchain_network - (Required) - eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\naction_params - (Optional) - A base64-encoded JSON object that contains the input parameters to a ChainJs composeAction call. The parameters differ based on the chain_action_type specified
\nExamples:
\nFor chain_action_type \"ValueTransfer\":
{
\"toAccountName\": \"0x27105356F6C1ede0e92020e6225E46DC1F496b81\",
\"amount\": \".0000000001\",
\"precision\": 18,
\"symbol\": \"ether\"
}
For chain_action_type \"TransferTransfer\":
{
fromAccountName: 'oreidfunding',
toAccountName: 'proppropprop',
amount: '0.1000',
symbol: 'EOS',
permission: 'active'
}
transactionAction - A base64-encoded JSON object. This object includes an action that can be sent to ORE ID to be signed.
\nView a complete list of the error codes
\n\n","urlObject":{"path":["api","transaction","compose-action"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"5d78b752-95f6-42bb-aee7-aacab4c392f7","name":"Transaction - Compose Action ERC20 Transfer","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":"{{service_key_airdrop}}","description":"(REQUIRED) - A service key that is authorized for airdrops. See Funding Account on oreid.io/developer"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chain_network\": \"eth_ropsten\",\n \"chain_action_type\": \"ERC20Transfer\",\n \"action_params\": \"ewogICAgICAiY29udHJhY3RBZGRyZXNzIjogIjB4MjcxMDUzNTZmNmMxZWRlMGU5MjAyMGU2MjI1ZTQ2ZGMxZjQ5NmI4MSIsCiAgICAgICJwcmVjaXNpb24iOiAxOCwKICAgICAgInZhbHVlIjogIjIwIgp9\"\n}\n"},"url":"service.oreid.io/api/transaction/compose-action"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"111"},{"key":"ETag","value":"W/\"6f-1odbdceBo5CqyhhaB1lp/l4/Y2Y\""},{"key":"Date","value":"Sat, 03 Oct 2020 00:02:20 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAction\": \"eyJ0byI6IjB4MjcxMDUzNTZmNmMxZWRlMGU5MjAyMGU2MjI1ZTQ2ZGMxZjQ5NmI4MSIsImNvbnRyYWN0Ijp7ImFiaSI6W3siYW5vbnltb3VzIjpmYWxzZSwiaW5wdXRzIjpbeyJpbmRleGVkIjp0cnVlLCJpbnRlcm5hbFR5cGUiOiJhZGRyZXNzIiwibmFtZSI6Im93bmVyIiwidHlwZSI6ImFkZHJlc3MifSx7ImluZGV4ZWQiOnRydWUsImludGVybmFsVHlwZSI6ImFkZHJlc3MiLCJuYW1lIjoic3BlbmRlciIsInR5cGUiOiJhZGRyZXNzIn0seyJpbmRleGVkIjpmYWxzZSwiaW50ZXJuYWxUeXBlIjoidWludDI1NiIsIm5hbWUiOiJ2YWx1ZSIsInR5cGUiOiJ1aW50MjU2In1dLCJuYW1lIjoiQXBwcm92YWwiLCJ0eXBlIjoiZXZlbnQifSx7ImFub255bW91cyI6ZmFsc2UsImlucHV0cyI6W3siaW5kZXhlZCI6dHJ1ZSwiaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJmcm9tIiwidHlwZSI6ImFkZHJlc3MifSx7ImluZGV4ZWQiOnRydWUsImludGVybmFsVHlwZSI6ImFkZHJlc3MiLCJuYW1lIjoidG8iLCJ0eXBlIjoiYWRkcmVzcyJ9LHsiaW5kZXhlZCI6ZmFsc2UsImludGVybmFsVHlwZSI6InVpbnQyNTYiLCJuYW1lIjoidmFsdWUiLCJ0eXBlIjoidWludDI1NiJ9XSwibmFtZSI6IlRyYW5zZmVyIiwidHlwZSI6ImV2ZW50In0seyJpbnB1dHMiOlt7ImludGVybmFsVHlwZSI6ImFkZHJlc3MiLCJuYW1lIjoib3duZXIiLCJ0eXBlIjoiYWRkcmVzcyJ9LHsiaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJzcGVuZGVyIiwidHlwZSI6ImFkZHJlc3MifV0sIm5hbWUiOiJhbGxvd2FuY2UiLCJvdXRwdXRzIjpbeyJpbnRlcm5hbFR5cGUiOiJ1aW50MjU2IiwibmFtZSI6IiIsInR5cGUiOiJ1aW50MjU2In1dLCJzdGF0ZU11dGFiaWxpdHkiOiJ2aWV3IiwidHlwZSI6ImZ1bmN0aW9uIn0seyJpbnB1dHMiOlt7ImludGVybmFsVHlwZSI6ImFkZHJlc3MiLCJuYW1lIjoic3BlbmRlciIsInR5cGUiOiJhZGRyZXNzIn0seyJpbnRlcm5hbFR5cGUiOiJ1aW50MjU2IiwibmFtZSI6ImFtb3VudCIsInR5cGUiOiJ1aW50MjU2In1dLCJuYW1lIjoiYXBwcm92ZSIsIm91dHB1dHMiOlt7ImludGVybmFsVHlwZSI6ImJvb2wiLCJuYW1lIjoiIiwidHlwZSI6ImJvb2wifV0sInN0YXRlTXV0YWJpbGl0eSI6Im5vbnBheWFibGUiLCJ0eXBlIjoiZnVuY3Rpb24ifSx7ImlucHV0cyI6W3siaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJhY2NvdW50IiwidHlwZSI6ImFkZHJlc3MifV0sIm5hbWUiOiJiYWxhbmNlT2YiLCJvdXRwdXRzIjpbeyJpbnRlcm5hbFR5cGUiOiJ1aW50MjU2IiwibmFtZSI6IiIsInR5cGUiOiJ1aW50MjU2In1dLCJzdGF0ZU11dGFiaWxpdHkiOiJ2aWV3IiwidHlwZSI6ImZ1bmN0aW9uIn0seyJpbnB1dHMiOlt7ImludGVybmFsVHlwZSI6InVpbnQyNTYiLCJuYW1lIjoiYW1vdW50IiwidHlwZSI6InVpbnQyNTYifV0sIm5hbWUiOiJidXJuIiwib3V0cHV0cyI6W10sInN0YXRlTXV0YWJpbGl0eSI6Im5vbnBheWFibGUiLCJ0eXBlIjoiZnVuY3Rpb24ifSx7ImlucHV0cyI6W3siaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJzcGVuZGVyIiwidHlwZSI6ImFkZHJlc3MifSx7ImludGVybmFsVHlwZSI6InVpbnQyNTYiLCJuYW1lIjoic3VidHJhY3RlZFZhbHVlIiwidHlwZSI6InVpbnQyNTYifV0sIm5hbWUiOiJkZWNyZWFzZUFsbG93YW5jZSIsIm91dHB1dHMiOlt7ImludGVybmFsVHlwZSI6ImJvb2wiLCJuYW1lIjoiIiwidHlwZSI6ImJvb2wifV0sInN0YXRlTXV0YWJpbGl0eSI6Im5vbnBheWFibGUiLCJ0eXBlIjoiZnVuY3Rpb24ifSx7ImlucHV0cyI6W3siaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJzcGVuZGVyIiwidHlwZSI6ImFkZHJlc3MifSx7ImludGVybmFsVHlwZSI6InVpbnQyNTYiLCJuYW1lIjoiYWRkZWRWYWx1ZSIsInR5cGUiOiJ1aW50MjU2In1dLCJuYW1lIjoiaW5jcmVhc2VBbGxvd2FuY2UiLCJvdXRwdXRzIjpbeyJpbnRlcm5hbFR5cGUiOiJib29sIiwibmFtZSI6IiIsInR5cGUiOiJib29sIn1dLCJzdGF0ZU11dGFiaWxpdHkiOiJub25wYXlhYmxlIiwidHlwZSI6ImZ1bmN0aW9uIn0seyJpbnB1dHMiOlt7ImludGVybmFsVHlwZSI6InVpbnQyNTYiLCJuYW1lIjoiYW1vdW50IiwidHlwZSI6InVpbnQyNTYifV0sIm5hbWUiOiJpc3N1ZSIsIm91dHB1dHMiOlt7ImludGVybmFsVHlwZSI6ImJvb2wiLCJuYW1lIjoiIiwidHlwZSI6ImJvb2wifV0sInN0YXRlTXV0YWJpbGl0eSI6Im5vbnBheWFibGUiLCJ0eXBlIjoiZnVuY3Rpb24ifSx7ImlucHV0cyI6W3siaW50ZXJuYWxUeXBlIjoidWludDI1NiIsIm5hbWUiOiJhbW91bnQiLCJ0eXBlIjoidWludDI1NiJ9XSwibmFtZSI6Im1pbnQiLCJvdXRwdXRzIjpbeyJpbnRlcm5hbFR5cGUiOiJib29sIiwibmFtZSI6IiIsInR5cGUiOiJib29sIn1dLCJzdGF0ZU11dGFiaWxpdHkiOiJub25wYXlhYmxlIiwidHlwZSI6ImZ1bmN0aW9uIn0seyJpbnB1dHMiOltdLCJuYW1lIjoidG90YWxTdXBwbHkiLCJvdXRwdXRzIjpbeyJpbnRlcm5hbFR5cGUiOiJ1aW50MjU2IiwibmFtZSI6IiIsInR5cGUiOiJ1aW50MjU2In1dLCJzdGF0ZU11dGFiaWxpdHkiOiJ2aWV3IiwidHlwZSI6ImZ1bmN0aW9uIn0seyJpbnB1dHMiOlt7ImludGVybmFsVHlwZSI6ImFkZHJlc3MiLCJuYW1lIjoicmVjaXBpZW50IiwidHlwZSI6ImFkZHJlc3MifSx7ImludGVybmFsVHlwZSI6InVpbnQyNTYiLCJuYW1lIjoiYW1vdW50IiwidHlwZSI6InVpbnQyNTYifV0sIm5hbWUiOiJ0cmFuc2ZlciIsIm91dHB1dHMiOlt7ImludGVybmFsVHlwZSI6ImJvb2wiLCJuYW1lIjoiIiwidHlwZSI6ImJvb2wifV0sInN0YXRlTXV0YWJpbGl0eSI6Im5vbnBheWFibGUiLCJ0eXBlIjoiZnVuY3Rpb24ifSx7ImlucHV0cyI6W3siaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJzZW5kZXIiLCJ0eXBlIjoiYWRkcmVzcyJ9LHsiaW50ZXJuYWxUeXBlIjoiYWRkcmVzcyIsIm5hbWUiOiJyZWNpcGllbnQiLCJ0eXBlIjoiYWRkcmVzcyJ9LHsiaW50ZXJuYWxUeXBlIjoidWludDI1NiIsIm5hbWUiOiJhbW91bnQiLCJ0eXBlIjoidWludDI1NiJ9XSwibmFtZSI6InRyYW5zZmVyRnJvbSIsIm91dHB1dHMiOlt7ImludGVybmFsVHlwZSI6ImJvb2wiLCJuYW1lIjoiIiwidHlwZSI6ImJvb2wifV0sInN0YXRlTXV0YWJpbGl0eSI6Im5vbnBheWFibGUiLCJ0eXBlIjoiZnVuY3Rpb24ifSx7ImNvbnN0YW50Ijp0cnVlLCJpbnB1dHMiOltdLCJuYW1lIjoiZGVjaW1hbHMiLCJvdXRwdXRzIjpbeyJuYW1lIjoiZGVjaW1hbHMiLCJ0eXBlIjoidWludDgifV0sInBheWFibGUiOmZhbHNlLCJ0eXBlIjoiZnVuY3Rpb24ifV0sInBhcmFtZXRlcnMiOltudWxsLCIyMDAwMDAwMDAwMDAwMDAwMDAwMCJdLCJtZXRob2QiOiJ0cmFuc2ZlciJ9fQ==\"\n}"},{"id":"1319ef60-af08-4a28-9e24-e47af3f04d62","name":"Transaction - Compose Action Currency Transfer","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":"{{service_key_airdrop}}","description":"(REQUIRED) - A service key that is authorized for airdrops. See Funding Account on oreid.io/developer"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chain_network\": \"eth_ropsten\",\n \"chain_action_type\": \"ValueTransfer\",\n \"action_params\": \"ewogICAgICAidG9BY2NvdW50TmFtZSI6ICIweDI3MTA1MzU2RjZDMWVkZTBlOTIwMjBlNjIyNUU0NkRDMUY0OTZiODEiLAogICAgICAiYW1vdW50IjogIi4wMDAwMDAwMDAxIiwKICAgICAgInByZWNpc2lvbiI6IDE4LAogICAgICAic3ltYm9sIjogImV0aGVyIgp9\"\n}\n"},"url":"service.oreid.io/api/transaction/compose-action"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"111"},{"key":"ETag","value":"W/\"6f-1odbdceBo5CqyhhaB1lp/l4/Y2Y\""},{"key":"Date","value":"Sat, 03 Oct 2020 00:02:20 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAction\": \"eyJ0byI6IjB4MjcxMDUzNTZGNkMxZWRlMGU5MjAyMGU2MjI1RTQ2REMxRjQ5NmI4MSIsInZhbHVlIjoiMDVmNWUxMDAifQ==\"\n}"}],"_postman_id":"6fd81e5a-60d4-4465-b169-ec204a21ad96"},{"name":"Transaction - Validate","id":"34b08fc7-78ae-4bd6-bed4-840acd18bd57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"description":"(OPTIONAL) The service account key for ORE ID Enterprise
\n","key":"service-key","type":"text","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain_network\": \"eos_kylin\",\n \"encoded_transaction\": \"...\",\n \"transaction_chain_account\": \"...\",\n \"transaction_options_stringified\": \"...\",\n \"transaction_recordId\": \"...\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/validate","description":"Checks whether a transaction can be signed (via Custodial - Sign Transaction) without requiring user intervention. A transaction can be auto-signed if the user has previously authorized auto-sign for a specific transaction contract/action (while signing a similar transaction) and if those auto-sign credentials have not yet expired. If autoSignCredentialsExist is true, then the transaction can be signed by calling Custodial - Sign Transaction and including auto_sign=true param. This endpoint also let's you know if the user can authorized auto-sign for this type of transaction (canCreateAutoSignCredentials).
\naccount - (Required) The 12-character ORE account name of the user signing the transaction.
\nchain_account - (Required) The 12-character account name associated with the transaction (the transaction actor) for the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\ntransaction - (Optional) Base64 encoded JSON of the transaction.
\nsigned_transaction - (Optional) Base64 encoded JSON of a transaction that already includes at least one signature.
\nNote: Either transaction or signed_transaction must be provided (but not both)
\nautoSignCredentialsExist - (boolean) Whether the user has autorized auto-sign for a similar transaction (all the same contract actions) and the auto-sign credentials have not yet expired
\ncanCreateAutoSignCredentials - (boolean) Whether the user is allowed to choose 'Use Auto-Sign for future transactions of this type' on the Sign Transaction screen
\nmaxAutoSignValidForInSeconds - (Integer) The maxiumum time that an auto-sign credential can exist for this type of transaction before expiring. Useful for letting a user know how long an auto-sign authorization will last for
\nerrorCode - (string) 'autoSignCheckFailed'
\nerrorMessage - (string) Detailed message(s) detailing which actions are enabled (or disallowed) for auto-sign
\n","urlObject":{"path":["api","transaction","validate"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"19d7c4f1-6664-4efb-a744-b05d68bde706","name":"Validate","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"","type":"text","description":"(REQUIRED) The api-key for your application on ORE ID."},{"key":"service-key","value":"","description":"(OPTIONAL) The service account key for ORE ID Enterprise","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain_network\": \"eos_kylin\",\n \"encoded_transaction\": \"...\",\n \"transaction_chain_account\": \"...\",\n \"transaction_options_stringified\": \"...\",\n \"transaction_recordId\": \"...\"\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/sign-string"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"53dd9029d455\",\n \"signature\": \"SIG_K1_K4b2ugoHQGrzA2K8PixSq6p2pM1yBMxApduedh9YoUSRcXktQLk8BNCyjr7gQYSd5iqWbpkreim3MxxVVTyU6KRU3TEpPa\"\n}"},{"id":"ed0d3d41-3de9-4cb8-947b-f54d3d2b205a","name":"Validate Eth Tx","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"","type":"text","description":"(REQUIRED) The api-key for your application on ORE ID."},{"key":"service-key","value":"","description":"(OPTIONAL) The service account key for ORE ID Enterprise","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain_network\": \"eth_goerli\",\n \"encoded_transaction\": \"IntcbiAgXCJmcm9tXCI6IFwiMHg1Yjk3MWJmN2YzMTZhZDZhMDIwNzVjZmM5MjBlZTkyYjg5NDU3NWJhXCIsXG4gIFwidG9cIjogXCIweGJlNzcwN2Y1Y2U0MDRkYjE0MmUxMzc5ZWE4YmE2NDZkMTUwZWJmZDdcIixcbiAgXCJ2YWx1ZVwiOiBcIjB4MDFcIlxufSI=\",\n \"transaction_chain_account\": null,\n \"transaction_options_stringified\": null\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/sign-string"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"53dd9029d455\",\n \"signature\": \"SIG_K1_K4b2ugoHQGrzA2K8PixSq6p2pM1yBMxApduedh9YoUSRcXktQLk8BNCyjr7gQYSd5iqWbpkreim3MxxVVTyU6KRU3TEpPa\"\n}"}],"_postman_id":"34b08fc7-78ae-4bd6-bed4-840acd18bd57"},{"name":"Transaction - Validate Payer","id":"46a6292c-c0ed-4008-970b-44b75a9123d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"description":"(OPTIONAL) The service account key for ORE ID Enterprise
\n","key":"service-key","type":"text","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain_network\": \"eos_kylin\",\n \"encoded_transaction\": \"...\",\n\t\"transaction_chain_account\": \"...\",\n \"payer_chain_account\": \"...\",\n \"transaction_options_stringified\": \"...\",\n \"transaction_recordId\": \"...\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/validate-payer","description":"Checks whether a transaction can be signed (via Custodial - Sign Transaction) without requiring user intervention. A transaction can be auto-signed if the user has previously authorized auto-sign for a specific transaction contract/action (while signing a similar transaction) and if those auto-sign credentials have not yet expired. If autoSignCredentialsExist is true, then the transaction can be signed by calling Custodial - Sign Transaction and including auto_sign=true param. This endpoint also let's you know if the user can authorized auto-sign for this type of transaction (canCreateAutoSignCredentials).
\naccount - (Required) The 12-character ORE account name of the user signing the transaction.
\nchain_account - (Required) The 12-character account name associated with the transaction (the transaction actor) for the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
\nchain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\ntransaction - (Optional) Base64 encoded JSON of the transaction.
\nsigned_transaction - (Optional) Base64 encoded JSON of a transaction that already includes at least one signature.
\nNote: Either transaction or signed_transaction must be provided (but not both)
\nautoSignCredentialsExist - (boolean) Whether the user has autorized auto-sign for a similar transaction (all the same contract actions) and the auto-sign credentials have not yet expired
\ncanCreateAutoSignCredentials - (boolean) Whether the user is allowed to choose 'Use Auto-Sign for future transactions of this type' on the Sign Transaction screen
\nmaxAutoSignValidForInSeconds - (Integer) The maxiumum time that an auto-sign credential can exist for this type of transaction before expiring. Useful for letting a user know how long an auto-sign authorization will last for
\nerrorCode - (string) 'autoSignCheckFailed'
\nerrorMessage - (string) Detailed message(s) detailing which actions are enabled (or disallowed) for auto-sign
\n","urlObject":{"path":["api","transaction","validate-payer"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"ef731991-aa33-4fa8-a3a7-bc2a72cbf4eb","name":"Validate Payer","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"","type":"text","description":"(REQUIRED) The api-key for your application on ORE ID."},{"key":"service-key","value":"","description":"(OPTIONAL) The service account key for ORE ID Enterprise","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain_network\": \"eos_kylin\",\n \"encoded_transaction\": \"...\",\n\t\"transaction_chain_account\": \"...\",\n \"payer_chain_account\": \"...\",\n \"transaction_options_stringified\": \"...\",\n \"transaction_recordId\": \"...\"\n}","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/transaction/validate-payer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jun 2019 20:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-zrqJFgzPTCnU9wpxASitkyQKYyA\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"processId\": \"53dd9029d455\",\n \"signature\": \"SIG_K1_K4b2ugoHQGrzA2K8PixSq6p2pM1yBMxApduedh9YoUSRcXktQLk8BNCyjr7gQYSd5iqWbpkreim3MxxVVTyU6KRU3TEpPa\"\n}"}],"_postman_id":"46a6292c-c0ed-4008-970b-44b75a9123d6"},{"name":"Transaction - Sign","id":"94e978ba-1938-4944-89db-38b5194c40c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.
\n","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"0x...\",\n\t\"chain_network\": \"eth_goerli\",\n\t\"chain_account\": \"0x...\",\n \"string_to_sign\": \"something to sign\",\n \"sign_method\": \"ethereum.personal-sign\",\n \"user_password\": \"...\",\n \"user_password_encrypted\": \"...\"\n}\n"},"url":"service.oreid.io/api/transaction/sign","description":"Sign a string with the user's chainAccount. Returns a Base4 encoded signed Transaction and/or transaction ID
\naccount - (Required) The user's ORE ID account name. This is often the same as the chain_account but it does not have to be as the user can have more than one chain_account or may be different on different chains
broadcast - (Optional) If true, the transaction will be submitted after being signed.
\nchain_account - (Required) The 12-character account name on the chain specified by chain_network. Usually the same as the user’s ORE account but can be different for different chains.
chain_network - (Required) eos_main, eos_kylin, etc. Valid options can be found in the Get Settings - Chains Config API call results
\nexpire_seconds - (Optional) Override the default transaction timeout. Can be up to 3000 (5 mins). Useful if your app takes a while to send transaction to have it signed (or if the network is congested)
\nmultisig_chain_accounts - (Optional) Comma seperated list of chain accounts for which ORE ID should add signatures to the transaction. Should NOT include the user's account as specified above in chain_account. Note: ORE ID must be provided with the private keys for additional signer accounts as part of the app configuration
\ntransaction - (Required) The transaction or string that you intend to sign.
\ntransaction_chain_account - (Optional) The target of the transaction (aka 'from' account)- usually only different from chainAccount for multisig transactions
\ntransaction_record_id - (Optional)
\nuser_password - (Optional) The user’s password (the same password as used when creating the user’s account - aka user PIN). Must be included if the user_password_encrypted is not included.
user_password_encrypted - (Optional) The user’s encrypted password (the same password as used when creating the user’s account - aka user PIN). Must be included if the user_password is not included.
allow_chain_account_selection - (Optional) Allow user to choose an alternative chain account (and permission) during the signing process. This would allow the user to choose an account in an external wallet (e.g. Scatter) to sign with. The selected account would replace the chain_account and permission used to sign the transaction.
\nauto_sign - (Optional)
\ngenerate_auto_sign_credentials - (Optional)
\nreturn_signed_transaction - (Optional) (Defaults to true) - If false, doesn’t return signed transaction object in results.
\nsigned_transaction - Base64 encoded signed transaction - in the 'raw' format ready to be transmitted to the chain (if broadcast=true, it will have already been submitted)
\ntransaction_id - Transaction ID (if available) - can be used to look-up the transaction on a block explorer
\nView a complete list of the error codes
\n\n","urlObject":{"path":["api","transaction","sign"],"host":["service.oreid.io"],"query":[],"variable":[]}},"response":[{"id":"0b29187e-8c48-4bc5-9ca4-d444ad2f9f56","name":"Custodial - Sign String","originalRequest":{"method":"POST","header":[{"description":"(REQUIRED) The api-key for your application on ORE ID.","key":"api-key","type":"text","value":""},{"key":"service-key","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account\": \"ore1tky1zwwe\",\n\t\"chain_network\": \"eos_kylin\",\n\t\"chain_account\": \"ore1tky1zwwe\",\n \"string_to_sign\": \"something to sign\",\n \"user_password\": \"2233\"\n}\n","options":{"raw":{"language":"json"}}},"url":"service.oreid.io/api/custodial/sign-string"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Aug 2020 19:28:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"228"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"e4-/WUDk3RmMhdGg5QQujs0tZNMle0\""},{"key":"Via","value":"1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"signed_transaction\": \"W3sic2VyaWFsaXplZFRyYW5zYWN0aW9uIjoiMSIsInNpZ25hdHVyZXMiOiIyIiwidHJhbnNhY3Rpb25JZCI6IjMifSxbMTAzLDE3Miw0NSw5NSwxNDgsOTIsMTQsNDcsMTE2LDI1MywwLDAsMCwwLDEsNjQsOTksODQsMTczLDg2LDY3LDE2NSw3NCwwLDAsMCwwLDAsMCwxMjgsMTA3LDEsNDgsMTA2LDEwNCwxOTEsMTM1LDI3LDIxMiwxNjUsNjQsNTEsMjE0LDEzNiw3NCwxNDksMTA2LDUzLDgsNDgsMTA2LDEwNCwxOTEsMTM1LDI3LDIxMiwxNjUsMF0sWyI0Il0sImRiZWIzZWE2OTQ0YjkwODY5ZTBlYTQxM2RkOWUyZmI2YmUxNTFiZGYxOGYzNWQ2NTY4MTY1ZjVjNDZjYmExNTkiLCJTSUdfSzFfSzhYS0E4dlF5a1ZVdkpyaFN2blBRdkQ0ODhWN1ZCeDlwclBjQ1B3alBQS0dNV05STWlWeVZxQ1ZVUFdwckZTaFhoVWF3eVI5Z1ZqaUdSZzZOWE00WVRwc29SZ1hSMyJd\",\n \"process_id\": \"3bf0cdf73c7e\"\n}\n"}],"_postman_id":"94e978ba-1938-4944-89db-38b5194c40c1"}],"id":"d4ed4253-d539-463f-a3e1-57a23f727b44","_postman_id":"d4ed4253-d539-463f-a3e1-57a23f727b44","description":""}],"event":[{"listen":"prerequest","script":{"id":"c87d8fe5-4ff7-43bd-9288-4e25c3a28fcc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4727ae8b-930c-44da-ab28-9073a10e6775","type":"text/javascript","exec":[""]}}],"variable":[{"key":"api_key","value":""},{"key":"service_key","value":""},{"key":"oreid_url","value":"service.oreid.io"}]}