{"info":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","description":"

The ares API exposes the entire ares infrastructure via a standardized programmatic interface. Using the ares API, you can do just about anything you can do on ares arena, while using your programming language of choice. The ares API is a RESTful API based on HTTP requests and JSON responses.

This version of the API, version 1, uses OAuth 2.0. This means that all requests will need to be encrypted and sent via HTTPS. It also means that you need to register your application, even if you aren't allowing users to login.

The easiest way to start using the ares API is by clicking the Run in Postman button above. Postman is a free tool which helps developers run and debug API requests, and is the source of truth for this documentation. Every endpoint you see documented here is readily available by running our Postman collection.

Client SDKs

Client SDKs help you to quickly integrate the ares API into your application without the need to go into the details of the API documentation below. Following a list of official client SDKs:

Register Application

\n
There are cases where its not possible to securely store a client secret, e.g. for mobile or desktop applications. In such situations you may register your application as a public client without a secret. This only works for the Authorization Code flow.
\n

Register your application.
\n
$\"Register$
\n
The field Redirect URIs must contain all callback/redirect URIs you want to use during oauth2 authorization requests. Specifying a redirect_uri for an authorization request that is not contained in this whitelist will cause an error. The redirect_uri is used to detemine where the user gets redirected to after confirming or dismissing an authorization request.
\n
$\"Register$
\n
Copy & securely store provided client_id and client_secret. You will not be able to recover the client_secret later on.
\n

Authorize Application - Postman

Download Postman and click the Run in Postman button at the top of this page. This will load our collection of endpoints into Postman for easy debugging.
\n
$\"Authorize$
\n
Edit the imported ares collection and open the Authorization tab.
\n
$\"Authorize$
\n
Click Get New Access Token and fill fields of presented dialog as follows:
\n
- Grant Type Client Credentials
- Access Token URL https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token
- Client ID Your Client ID
- Client Secret Your Client Secret
- Scope identity account owner
- Client Authentication Send as Basic Auth header
\n
Confirm by clicking Request Token and Use Token on the following screen.
\n

Authorize Application - Swagger

Alternatively you may use our hosted Swagger UI to try out the ares API. Simply click the Authorize button on top of the page and enter your Client ID and Client Secret.

Authorize Application - Custom

The ares API offers two oauth2 flows to authorize your own applications:

Authorization Code flow Request authorization for your application from another user. For example to make requests with limited permissions on behalf of that user.
\n
Client Credentials flow Authorize your application to act as the user that registered the application and generated corresponding Client ID and Client Secret.
\n

Access Token

No matter what authorization flow you choose, if all goes well you end up with an access token. The ares API is designed to be stateless. Consequently all session & authorization related information is embedded in the access token encoded as a JSON Web Token [JWT].

An ares API access token consists of a header, a body and a signature separated by dots. Typically resulting in something similar to this (w/o linebreaks):

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9\n.\neyJzdWIiOiJkNjNkNmJjNGNkN2E3ODllMjNiNTY1MDM4MzgwNTMwZDE2OWVmNWZiMDQ3Zjhh\nZmMxMWVkNzk2ZiIsImlhdCI6MTU0MDM4MjQ1NSwiZXhwIjoxNTQwMzg2MDU1LCJhdWQiOiJm\nNmFmM2QwMC1kNzgyLTExZTgtOTZjNi0xM2I3NjlmNTdhMDYiLCJwcnYiOnsidmFsdWVzIjp7\nImFjY291bnQiOnsidHlwZSI6Im1haWwiLCJ2YWx1ZSI6ImNhcnN0ZW4uc2NoaXBrZUBnbWFp\nbC5jb20ifSwiaWRlbnRpdHkiOnsiZXRoIjoiMHg0MzVkMDRjOTI5MmVhNWZhMDk2ZWQwYmUz\nOTVlMmM0ZTExNDQ2MzFlIiwiYmRiIjoiOU5RMndyQ1ZmeERqUE5jOEFnMkRvVnF0SjV5blBO\nU3NLeXBVU0ZiUkxIZXQifSwib3duZXIiOnt9fSwic2NvcGVzIjpbImlkZW50aXR5IiwiYWNj\nb3VudCIsIm93bmVyIl19fQ\n.\nPbK0Uysqh5qWS_Z9gT3VIYYb_sh0Y4oAVlamgROLfAjG-AO7kYMrTPRjQ5LUWKR88zwvxUwJ\n4Q1ssk-Dy4J66IX-2nrvbcHiQv0E4IQW3v3hXZGVQQJfMsehdKrKK-TbFSTihVD-4v8N_MDZ\nunLlDUpKywFl1t-D_FqA3jzCKQE\n

The header contains information about token type and utilised signature algorithm.
\n
The body is a regular base64 encoded JSON string, containing useful information for both ares API nodes as well as API clients / applications:
\n
```
{\n    \"sub\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a\",\n    \"aud\": \"arena\",\n    \"prv\": {\n        \"values\": {\n            \"identity\": {\n                \"bdb\": \"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\",\n                \"eth\": \"0xea4ba38cf229f7bd8a5b99daea3914cf16899eed\"\n            },\n            \"account\": {\n                \"type\": \"mail\",\n                \"value\": \"carsten@arestech.io\"\n            },\n            \"owner\": {}\n        },\n        \"scopes\": [\n            \"identity\",\n            \"account\",\n            \"owner\"\n        ]\n    },\n    \"iat\": 1539333731,\n    \"exp\": 1539337331\n}\n
```
- sub Unique identifier of authenticated user
- aud Application / client authorized to use this token
- prv Payload containing additional information based on authorized scopes as well as an enumeration of the authorized scopes. identity contains associated blockchain identities, i.e. public keys / addresses. account contains the email address or mobile number the user used to register. owner currently merely acts as a placeholder. If a certain scope is not given or authorized, corresponding field in payload is encrypted.
- iat Issued at
- exp Expires at
\n
The signature provides ares API nodes and clients a way to ensure that the token has not been tampered with.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Client SDKs","slug":"client-sdks"},{"content":"Register Application","slug":"register-application"},{"content":"Authorize Application - Postman","slug":"authorize-application-postman"},{"content":"Authorize Application - Swagger","slug":"authorize-application-swagger"},{"content":"Authorize Application - Custom","slug":"authorize-application-custom"},{"content":"Access Token","slug":"access-token"}],"owner":"5572603","collectionId":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","publishedId":"RWgqUHvV","public":true,"customColor":{"top-bar":"F8F8F8","right-sidebar":"303030","highlight":"7400A4"},"publishDate":"2018-11-08T17:02:22.000Z"},"item":[{"name":"Authentication","item":[{"name":"OAuth2 - Authorization Code Flow - Request Authorization","id":"f4f37762-a542-4d3d-b170-96e9a4a32554","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth?response_type=&client_id=&redirect_uri=&scope=&state=","description":"

Use the Authorization Code flow to request authorization for your application from another user. For example to make requests with limited permissions on behalf of that user. The application can request authorization with the scopes identity and account. Whereby identity is mandatory and will automatically be included if the user authorizes your application. The optional scope account provides access to the user's account details, e.g. the email address or mobile number the user registered with.

To request authorization, open the parameterized authorization url as shown in a web browser and present it to the user you want to request authorization from.

If you miss mandatory, or provided illegal parameters, the user is redirected to redirect_uri with the query parameters error and state. Whereby state contains the value you provided upon request (optional), and error contains the value invalid_request.
If you provided an illegal or disabled client_id, the user is redirected to redirect_uri with the query parameters error and state. Whereby state contains the value you provided upon request (optional), and error contains the value unauthorized_client.
If the user denies authorization, he is redirected to redirect_uri with the query parameters error and state. Whereby state contains the value you provided upon request (optional), and error contains the value access_denied.
If the user confirms authorization, he is redirected to redirect_uri with the query parameters code, scope and state. Whereby state contains the value you provided upon request (optional), scope contains the scopes the user authorized and code contains the authorization code that you can exchange for an access token during the next step.

\n","urlObject":{"protocol":"https","path":["alpha","auth"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[{"description":{"content":"

Must be code

\n","type":"text/plain"},"key":"response_type","value":""},{"description":{"content":"

Your Application's Client ID

\n","type":"text/plain"},"key":"client_id","value":""},{"description":{"content":"

Your Application's Oauth2 Callback URI (must be one of your registered redirect uris)

\n","type":"text/plain"},"key":"redirect_uri","value":""},{"description":{"content":"

Can be any of identity, identity+account

\n","type":"text/plain"},"key":"scope","value":""},{"description":{"content":"

Optional custom parameter that will be passed through authorization and to your provided redirect_uri. Allows your application to identify the authorization request when the callback is invoked.

\n","type":"text/plain"},"key":"state","value":""}],"variable":[]}},"response":[{"id":"2c9c1ca2-d610-46bf-b2dc-593d425df71e","name":"OAuth2 - Authorization Code Flow - Obtain Authorization Code","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth?response_type=code&client_id=fca5b7c0-cca1-11e8-b7f3-efeb12087ebf&redirect_uri=https://domain.tld/oauth2/callback&scope=identity+account&state=c9ec83db0bfc273e43e09f6b06b7d5","protocol":"https","host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"path":["alpha","auth"],"query":[{"key":"response_type","value":"code","description":"Must be `code`"},{"key":"client_id","value":"fca5b7c0-cca1-11e8-b7f3-efeb12087ebf","description":"Your Application's *Client ID*"},{"key":"redirect_uri","value":"https://domain.tld/oauth2/callback","description":"Your Application's Oauth2 Callback URI (must be one of your registered redirect uris)"},{"key":"scope","value":"identity+account","description":"Requested Scope - can be any of `identity`, `account`, `identity+account`"},{"key":"state","value":"c9ec83db0bfc273e43e09f6b06b7d5","description":"Optional custom parameter that will be passed through authorization and to your provided callback uri. Allows your application to identity the authorization request when the callback is invoked."}]}},"status":"Temporary Redirect (since HTTP/1.1)","code":307,"_postman_previewlanguage":"text","header":[{"key":"Location","value":"https://domain.tld/oauth2/callback?code=7c77a6fd9c69938c0da89110c3c6cd04aa9d17673c0d0a852d2d198b&scope=identity+account&state=c9ec83db0bfc273e43e09f6b06b7d5","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"HTTP/1.1 307 Temporary Redirect\nLocation: https://domain.tld/oauth2/callback?code=7c77a6fd9c69938c0da89110c3c6cd04aa9d17673c0d0a852d2d198b&scope=identity+account&state=c9ec83db0bfc273e43e09f6b06b7d5"}],"_postman_id":"f4f37762-a542-4d3d-b170-96e9a4a32554"},{"name":"OAuth2 - Authorization Code Flow - Obtain Access Token","id":"2a529600-383b-49e9-af47-d78d20738e4e","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"","description":"

Basic base64({{client_id}}:{{client_secret}}) Alternative to Client ID and Client Secret in body

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"","description":"

Must be authorization_code

\n","type":"text"},{"key":"client_id","value":"","description":"

Your Application's Client ID. Alternative to Authorization header

\n","type":"text"},{"key":"client_secret","value":"","description":"

Your Application's Client Secret. Alternative to Authorization header

\n","type":"text"},{"key":"code","value":"","description":"

The authorization code provided to your redirect_uri in previous step

\n","type":"text"},{"key":"redirect_uri","value":"","description":"

Must match the redirect_uri of previous step requesting the authorization code

\n","type":"text"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token","description":"

Use the authorization code obtained in previous step to exchange it for an acces & refresh token pair.

\n","urlObject":{"protocol":"https","path":["alpha","auth","token"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"56923cef-46b1-46cc-8cdc-12f08f7e4bc4","name":"OAuth2 - Authorization Code Flow - Obtain Access Token - Basic Auth","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic ZmNhNWI3YzAtY2NhMS0xMWU4LWI3ZjMtZWZlYjEyMDg3ZWJmOmI5ODIwMDNjMjExMzY4MTg0M2FjYjhjMDM2NDM1OTg3YzMxYmY4ODA0YzZjN2NhMDJiNGZiMzhj","description":"Basic Auth. Alternative to *Client ID* and *Client Secret* in body","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"Must be `authorization_code`","type":"text"},{"key":"client_id","value":"{{client_id}}","description":"Your Application's *Client ID*. Alternative to `Authorization` header","type":"text","disabled":true},{"key":"client_secret","value":"{{client_secret}}","description":"Your Application's *Client Secret*. Alternative to `Authorization` header","type":"text","disabled":true},{"key":"code","value":"{{authorization_code}}","description":"The authorization code provided to your `redirect_uri` in previous step","type":"text"},{"key":"redirect_uri","value":"{{redirect_uri}}","description":"Must match the `redirect_uri` of previous step requesting the authorization code","type":"text"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"refresh_token\": \"5769b39c4a2c74cca1b51c036564f22d6d...\",\n \"token_type\": \"Bearer\",\n \"expiry\": 3600\n}"},{"id":"72f8dd08-0f1b-4ef4-ae50-42ad4d92e227","name":"OAuth2 - Authorization Code Flow - Obtain Access Token - Client ID & Client Secret","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"Must be `authorization_code`","type":"text"},{"key":"client_id","value":"fca5b7c0-cca1-11e8-b7f3-efeb12087ebf","description":"Your Application's *Client ID*","type":"text"},{"key":"client_secret","value":"b982003c2113681843acb8c036435987c31bf8804c6c7ca02b4fb38c","description":"Your Application's *Client Secret*","type":"text"},{"key":"code","value":"7c77a6fd9c69938c0da89110c3c6cd04aa9d17673c0d0a852d2d198b","description":"The authorization code provided to your `redirect_uri` in previous step","type":"text"},{"key":"redirect_uri","value":"https://domain.tld/oauth2/callback","description":"Must match the `redirect_uri` of previous step requesting the authorization code","type":"text"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"refresh_token\": \"5769b39c4a2c74cca1b51c036564f22d6d...\",\n \"token_type\": \"Bearer\",\n \"expiry\": 3600\n}"}],"_postman_id":"2a529600-383b-49e9-af47-d78d20738e4e"},{"name":"OAuth2 - Client Credentials Flow - Obtain Access Token","id":"7841a69d-1fe0-46bc-b297-8ed3d0c82af6","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"","description":"

Basic base64({{client_id}}:{{client_secret}}) Alternative to Client ID and Client Secret in body

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"","description":"

Must be client_credentials

\n","type":"text"},{"key":"client_id","value":"","description":"

Your Application's Client ID. Alternative to Authorization header

\n","type":"text"},{"key":"client_secret","value":"","description":"

Your Application's Client Secret. Alternative to Authorization header

\n","type":"text"},{"key":"scope","value":"","description":"

Scope - can be any of identity, identity+account, identity+account+owner

\n","type":"text"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token","description":"

Use the Client Credentials flow to authorize your application to act as the user that registered the application and generated associated Client ID and Client Secret. The application can request authorization with the scopes identity, account and owner. Whereby identity is mandatory and will automatically be included. The optional scope account provides access to the user's account details, e.g. the email address or mobile number the user registered with. The optional scope owner will grant ownership permissions. For example it allows your application to directly commit signed transactions without additional multi-factor authentication requests that may require manual interaction.

Basic base64({{client_id}}:{{client_secret}}) Alternative to Client ID and Client Secret in body

\n","key":"Authorization","type":"text","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

Must be refresh_token

\n","key":"grant_type","type":"text","value":""},{"description":"

Your Application's Client ID. Alternative to Authorization header

\n","key":"client_id","type":"text","value":""},{"description":"

Your Application's Client Secret. Alternative to Authorization header

\n","key":"client_secret","type":"text","value":""}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token","description":"

You may use the refresh token obtained along with the access token during authorization code flow to obtain a new access token if your current one expired, without asking the user again for authorization.

\n","urlObject":{"protocol":"https","path":["alpha","auth","token"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"2f3a8dae-1f82-426e-88be-3af5b222670d","name":"OAuth2 - Refresh Access Token - Basic Auth","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic ZmNhNWI3YzAtY2NhMS0xMWU4LWI3ZjMtZWZlYjEyMDg3ZWJmOmI5ODIwMDNjMjExMzY4MTg0M2FjYjhjMDM2NDM1OTg3YzMxYmY4ODA0YzZjN2NhMDJiNGZiMzhj","description":"Basic Auth. Alternative instead of *Client ID* and *Client Secret* in body","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Must be `refresh_token`","key":"grant_type","type":"text","value":"refresh_token"},{"description":"Your Application's *Client ID*. Alternative instead of `Authorization` header","key":"client_id","type":"text","value":"{{client_id}}","disabled":true},{"description":"Your Application's *Client Secret*. Alternative instead of `Authorization` header","key":"client_secret","type":"text","value":"{{client_secret}}","disabled":true},{"description":"Your Refresh Token","key":"refresh_token","type":"text","value":"5769b39c4a2c74cca1b51c036564f22d6d93e479b5045be6211dff26983257cf3f31310458b742e809ec32e4be900da5"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"refresh_token\": \"5769b39c4a2c74cca1b51c036564f22d6d...\",\n \"token_type\": \"Bearer\",\n \"expiry\": 3600\n}"},{"id":"9b997744-82c1-4c3f-a39d-5f49f6832b8d","name":"OAuth2 - Refresh Access Token - Client ID & Client Secret","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic base64({{client_id}}:{{client_secret}})","description":"Basic Auth. Alternative instead of *Client ID* and *Client Secret* in body","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Must be `refresh_token`","key":"grant_type","type":"text","value":"refresh_token"},{"description":"Your Application's *Client ID*. Alternative instead of `Authorization` header","key":"client_id","type":"text","value":"fca5b7c0-cca1-11e8-b7f3-efeb12087ebf"},{"description":"Your Application's *Client Secret*. Alternative instead of `Authorization` header","key":"client_secret","type":"text","value":"b982003c2113681843acb8c036435987c31bf8804c6c7ca02b4fb38c"},{"description":"Your Refresh Token","key":"refresh_token","type":"text","value":"5769b39c4a2c74cca1b51c036564f22d6d93e479b5045be6211dff26983257cf3f31310458b742e809ec32e4be900da5"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"refresh_token\": \"5769b39c4a2c74cca1b51c036564f22d6d...\",\n \"token_type\": \"Bearer\",\n \"expiry\": 3600\n}"}],"_postman_id":"e6c14c96-e70d-4d1c-b6da-7f6742e2258a"}],"id":"c8b24933-26d4-48c5-a065-1eb7888b84b7","event":[{"listen":"prerequest","script":{"id":"4535737a-4eed-4d84-985b-4737c3b21811","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"68427f2b-9736-4d08-9c77-2ab7bd30c9e9","type":"text/javascript","exec":[""]}}],"_postman_id":"c8b24933-26d4-48c5-a065-1eb7888b84b7","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}}},{"name":"Avatars","item":[{"name":"Resolve Avatars","id":"2c0944a5-589f-4022-98ff-7b85fa69b7e9","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/avatars","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}},"urlObject":{"protocol":"https","path":["alpha","avatars"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"96e9df43-7c66-4b73-a61e-eab953606745","name":"Resolve Avatars - Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/avatars"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"6029d211fc0a2867c9eeb3e70b95c7a63d6d84b986f61121ebb61574c6b65f5a\",\n \"name\": \"BAD$TAN\",\n \"url\": \"http://stan.to/\",\n \"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n }\n]"}],"_postman_id":"2c0944a5-589f-4022-98ff-7b85fa69b7e9"},{"name":"Create Avatar","id":"377fe3fe-dd21-43f8-8e38-dc98b6682b84","request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[{"description":"

Nickname

\n","key":"name","type":"text","value":""},{"description":"

Website (URL)

\n","key":"url","type":"text","value":""},{"description":"

Image (File)

\n","key":"image","type":"file","value":null}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/avatars","description":"

Create Avatar prepares an unsigned (pending) transaction to store an avatar owned by authenticated user on the blockchain. On success, status 201 Created is returned along with the headers X-Ares-Created-Id containing the id of the pending transaction as well as Location containing an authorization url for the pending transaction.

To actually sign & commit the transaction to the blockchain, the pending transaction must be resolved using provided id and signed & submitted to the transactions endpoint.

If your application does not have the necessary credentials, i.e. private key, to sign the transaction, for example if your application is creating the avatar on behalf of another user, the provided authorization url must be opened in a web browser and presented to the user instead.

To receive notification on whether the user authorized the transaction, the parameter redirect_uri can be appended to the authorization url. The user will be redirected there upon authorization / dismissal of requested transaction.

Nickname

\n","key":"name","type":"text","value":""},{"description":"

Website (URL)

\n","key":"url","type":"text","value":""},{"description":"

Image (File)

\n","key":"image","type":"file","value":null}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/avatars/{{id}}","description":"

Update Avatar prepares an unsigned (pending) transaction to update (transfer) an avatar owned by authenticated user on the blockchain. On success, status 201 Created is returned along with the headers X-Ares-Created-Id containing the id of the pending transaction as well as Location containing an authorization url for the pending transaction.

To actually sign & commit the transaction to the blockchain, the pending transaction must be resolved using provided id and signed & submitted to the transactions endpoint.

If your application does not have the necessary credentials, i.e. private key, to sign the transaction, for example if your application is updating the avatar on behalf of another user, the provided authorization url must be opened in a web browser and presented to the user instead.

Resolve raw transaction from underlying blockchain.

Can be any of root, child

\n","type":"text/plain"},"key":"scope","value":null}],"variable":[]}},"response":[{"id":"7ca29652-4914-49d4-b2e2-effea8794239","name":"Resolve Transaction - Root Chain","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions/eth/0xe39c107b6ca67e897b082df41c48cfa4ca4fe29b68a07ef454f15e678fd5050a?scope=root","protocol":"https","host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"path":["alpha","transactions","eth","0xe39c107b6ca67e897b082df41c48cfa4ca4fe29b68a07ef454f15e678fd5050a"],"query":[{"key":"scope","value":"root"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"chain\": \"eth\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"blockHash\": \"0x73d4e34a2ec2fa7f116534e3a5cfe28b89bff3c59e501f6a39d209f2f883dd26\",\n\t\t\"blockNumber\": 46865,\n\t\t\"from\": \"0x2b9bbd09ea584fccc972b069331a6ec5be390b39\",\n\t\t\"gas\": 46000,\n\t\t\"gasPrice\": \"5000000000\",\n\t\t\"hash\": \"0xe39c107b6ca67e897b082df41c48cfa4ca4fe29b68a07ef454f15e678fd5050a\",\n\t\t\"input\": \"0x\",\n\t\t\"nonce\": 1,\n\t\t\"to\": \"0x435d04c9292Ea5FA096Ed0be395e2C4e1144631E\",\n\t\t\"transactionIndex\": 0,\n\t\t\"value\": \"3000000000000000000\",\n\t\t\"v\": \"0xa95\",\n\t\t\"r\": \"0x7de3ab71e093336dfdd088a61cd1178890e03e0fbeb680b2519e9741d63d7f56\",\n\t\t\"s\": \"0x76010b90d591df1cd31060d5f295d38cb8188f7982a21618cafedb7defaf5083\"\n\t}\n}\n"},{"id":"e1305381-ddd0-4956-8975-e90289007b9e","name":"Resolve Transaction - Child Chain","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"url":{"raw":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions/eth/0xe39c107b6ca67e897b082df41c48cfa4ca4fe29b68a07ef454f15e678fd5050a?scope=child","protocol":"https","host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"path":["alpha","transactions","eth","0xe39c107b6ca67e897b082df41c48cfa4ca4fe29b68a07ef454f15e678fd5050a"],"query":[{"key":"scope","value":"child"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Nov 2018 11:19:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1244"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4f50c3e9-e411-11e8-b38a-7bdd171e94af"},{"key":"x-amzn-ErrorType","value":"IncompleteSignatureException"},{"key":"x-amz-apigw-id","value":"QF4BPG6MliAFiMQ="}],"cookie":[],"responseTime":null,"body":"{\n\t\"chain\":\"eth\",\n\t\"scope\":\"child\",\n\t\"value\":{\n\t\t\"txid\":\"E9A5947D2A852DD3F1D906052C435C76AAE52A1946D7E5C3457ED68EADE77807\",\n\t\t\"txblknum\":27833000,\n\t\t\"txindex\":0,\n\t\t\"cur12\":\"0000000000000000000000000000000000000000\",\n\t\t\"spender1\":\"435D04C9292EA5FA096ED0BE395E2C4E1144631E\",\n\t\t\"blknum1\":26870000,\n\t\t\"txindex1\":0,\n\t\t\"oindex1\":0,\n\t\t\"spender2\":\"435D04C9292EA5FA096ED0BE395E2C4E1144631E\",\n\t\t\"blknum2\":27793000,\n\t\t\"txindex2\":0,\n\t\t\"oindex2\":1,\n\t\t\"newowner1\":\"EA4BA38CF229F7BD8A5B99DAEA3914CF16899EED\",\n\t\t\"amount1\":56000000000000000000,\n\t\t\"newowner2\":\"0000000000000000000000000000000000000000\",\n\t\t\"amount2\":0,\n\t\t\"sig1\":\"EB40805A4892DF4FFE5CC031FE9E7445A81DA2E106B2B5286DD6BEA45CE2F0A14D3530D01F051B1A23A74651B6F319A1999948BB2B7F71680F0B47EF20C233FC1B\",\n\t\t\"sig2\":\"EB40805A4892DF4FFE5CC031FE9E7445A81DA2E106B2B5286DD6BEA45CE2F0A14D3530D01F051B1A23A74651B6F319A1999948BB2B7F71680F0B47EF20C233FC1B\"\n\t}\n}\n"}],"_postman_id":"38cb9efe-2d98-49b3-9f26-9e3a58417ca5"}],"id":"beeadac4-99c5-4d4e-af6a-30786316467a","_postman_id":"beeadac4-99c5-4d4e-af6a-30786316467a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}}},{"name":"Create Transaction","id":"7c7a833f-3374-4a2e-956a-723a97f2120d","request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"chain\": \"bdb\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"operation\": \"TRANSFER\",\n\t\t\"version\": \"2.0\",\n\t\t\"metadata\": {\n\t\t\t\"version\": \"7\",\n\t\t\t\"created_at\": \"2018-10-10T14:16:21.667Z\",\n\t\t\t\"values\": {\n\t\t\t\t\"ref\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a_avatar_7\",\n\t\t\t\t\"name\": \"Stan\",\n\t\t\t\t\"url\": \"http://stan.to/\",\n\t\t\t\t\"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n\t\t\t}\n\t\t},\n\t\t\"inputs\": [\n\t\t\t{\n\t\t\t\t\"fulfills\": {\n\t\t\t\t\t\"transaction_id\": \"e456671ffd7e7093e758100189cf51742b0c680b9bd71c6f73a8a67f50279e73\",\n\t\t\t\t\t\"output_index\": 0\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"outputs\": [\n\t\t\t{\n\t\t\t\t\"public_keys\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"amount\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}\n"},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions","description":"

Use Create Transaction to submit custom raw transactions to underlying blockchain.

If caller of this endpoint is authorized as owner of submitted transaction, and the transaction is signed, it is committed directly to underlying blockchain and status 201 Created is returned together with header X-Ares-Created-Id holding the id of created transaction.

Otherwise a pending transaction is created and status 202 Accepted is returned together with headers X-Ares-Created-Id holding the id of the pending transaction as well as Location holding an authorization url. To actually sign & commit the pending transaction to the blockchain, it must be resolved using provided id and signed & submitted to the transactions endpoint.

If your application does not have the necessary credentials, i.e. private key, to sign the transaction, for example if your application is creating the transaction on behalf of another user, the provided authorization url must be opened in a web browser and presented to the user instead.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}},"urlObject":{"protocol":"https","path":["alpha","transactions"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"29a6fc53-d09b-4a6e-9a1d-d99286ea4376","name":"Create Transaction - Accepted","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"chain\": \"bdb\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"operation\": \"TRANSFER\",\n\t\t\"version\": \"2.0\",\n\t\t\"metadata\": {\n\t\t\t\"version\": \"7\",\n\t\t\t\"created_at\": \"2018-10-10T14:16:21.667Z\",\n\t\t\t\"values\": {\n\t\t\t\t\"ref\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a_avatar_7\",\n\t\t\t\t\"name\": \"Stan\",\n\t\t\t\t\"url\": \"http://stan.to/\",\n\t\t\t\t\"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n\t\t\t}\n\t\t},\n\t\t\"inputs\": [\n\t\t\t{\n\t\t\t\t\"fulfills\": {\n\t\t\t\t\t\"transaction_id\": \"e456671ffd7e7093e758100189cf51742b0c680b9bd71c6f73a8a67f50279e73\",\n\t\t\t\t\t\"output_index\": 0\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"outputs\": [\n\t\t\t{\n\t\t\t\t\"public_keys\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"amount\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}\n"},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions"},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"HTTP/1.1 202 Accepted\nX-Ares-Created-Id: e8b03420-cdfa-11e8-8e78-2de832d5ac92\nLocation: https://d3ob2g5ep10o1o.cloudfront.net/account/transactions/authorize?transaction_id=e8b03420-cdfa-11e8-8e78-2de832d5ac92\n"},{"id":"54bb8e6f-5e22-45ea-b65c-a12888d8c850","name":"Create Transaction - Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain\": \"bdb\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"id\": \"6029d211fc0a2867c9eeb3e70b95c7a63d6d84b986f61121ebb61574c6b65f5a\",\n\t\t\"asset\": {\n\t\t\t\"id\": \"8304bd6557284fe98124389f834ab9b7a70e5cf436b490f35505dc497abf880a\"\n\t\t},\n\t\t\"operation\": \"TRANSFER\",\n\t\t\"version\": \"2.0\",\n\t\t\"metadata\": {\n\t\t\t\"version\": \"7\",\n\t\t\t\"created_at\": \"2018-10-10T14:16:21.667Z\",\n\t\t\t\"values\": {\n\t\t\t\t\"ref\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a_avatar_7\",\n\t\t\t\t\"name\": \"Stan\",\n\t\t\t\t\"url\": \"http://stan.to/\",\n\t\t\t\t\"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n\t\t\t}\n\t\t},\n\t\t\"inputs\": [\n\t\t\t{\n\t\t\t\t\"fulfills\": {\n\t\t\t\t\t\"transaction_id\": \"e456671ffd7e7093e758100189cf51742b0c680b9bd71c6f73a8a67f50279e73\",\n\t\t\t\t\t\"output_index\": 0\n\t\t\t\t},\n\t\t\t\t\"owners_before\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"fulfillment\": \"pGSAIAFa-Szbnr5RLwf4vc_-Lqrv4-mkuuFEyUi_J3zWk9A8gUB3n7t5Cf9Xls8EgA6mGDOWDlA_gIrU9JP7oBdvQOn20Bt4eH1zvmcDbH0nIhpegOZ17TPOEe6b1nmDH1cOqi8D\"\n\t\t\t}\n\t\t],\n\t\t\"outputs\": [\n\t\t\t{\n\t\t\t\t\"public_keys\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"condition\": {\n\t\t\t\t\t\"uri\": \"ni:///sha-256;HpCANV2iJLSvCg0UKqiXcaAvhRPxJIp5dh_G7HLDxCY?fpt=ed25519-sha-256&cost=131072\",\n\t\t\t\t\t\"details\": {\n\t\t\t\t\t\t\"type\": \"ed25519-sha-256\",\n\t\t\t\t\t\t\"public_key\": \"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"amount\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}\n"},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/avatars"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"X-Ares-Created-Id","value":"e8b03420-cdfa-11e8-8e78-2de832d5ac92","description":"","type":"text"},{"key":"Location","value":"https://d3ob2g5ep10o1o.cloudfront.net/account/transactions/authorize?transaction_id=e8b03420-cdfa-11e8-8e78-2de832d5ac92","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"HTTP/1.1 201 Created\nX-Ares-Created-Id: 6029d211fc0a2867c9eeb3e70b95c7a63d6d84b986f61121ebb61574c6b65f5a\n"}],"_postman_id":"7c7a833f-3374-4a2e-956a-723a97f2120d"},{"name":"Resolve Pending Transaction","id":"421c0a9b-9e91-498b-a37b-f853d41a37b8","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions/pending/{{id}}","description":"

Resolve Pending Transaction for signing.

Create Transaction as well as other mutating endpoints generally return an id for a pending transaction, unless a signed transaction by an authorized owner has been submitted in the first place.

Corresponding pending transaction can be resolved by invoking this endpoint with previously obtained id as path parameter. The returned transaction can be signed using the ares client SDK, and committed to underlying blockchain by submitting it to the Sign Pending Transaction endpoint. Please refer to the ares client SDK documentation for details on how to sign transactions.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}},"urlObject":{"protocol":"https","path":["alpha","transactions","pending","{{id}}"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"483a0694-0a9b-4c99-937d-07f885d12d7c","name":"Resolve Pending Transaction - Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions/pending/e8b03420-cdfa-11e8-8e78-2de832d5ac92"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"chain\": \"bdb\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"operation\": \"TRANSFER\",\n\t\t\"version\": \"2.0\",\n\t\t\"metadata\": {\n\t\t\t\"version\": \"7\",\n\t\t\t\"created_at\": \"2018-10-10T14:16:21.667Z\",\n\t\t\t\"values\": {\n\t\t\t\t\"ref\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a_avatar_7\",\n\t\t\t\t\"name\": \"Stan\",\n\t\t\t\t\"url\": \"http://stan.to/\",\n\t\t\t\t\"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n\t\t\t}\n\t\t},\n\t\t\"inputs\": [\n\t\t\t{\n\t\t\t\t\"fulfills\": {\n\t\t\t\t\t\"transaction_id\": \"e456671ffd7e7093e758100189cf51742b0c680b9bd71c6f73a8a67f50279e73\",\n\t\t\t\t\t\"output_index\": 0\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"outputs\": [\n\t\t\t{\n\t\t\t\t\"public_keys\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"amount\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}\n"}],"_postman_id":"421c0a9b-9e91-498b-a37b-f853d41a37b8"},{"name":"Sign Pending Transaction","id":"08de676f-71f1-4690-97e3-adb8fadc39c0","request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"chain\": \"bdb\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"id\": \"6029d211fc0a2867c9eeb3e70b95c7a63d6d84b986f61121ebb61574c6b65f5a\",\n\t\t\"asset\": {\n\t\t\t\"id\": \"8304bd6557284fe98124389f834ab9b7a70e5cf436b490f35505dc497abf880a\"\n\t\t},\n\t\t\"operation\": \"TRANSFER\",\n\t\t\"version\": \"2.0\",\n\t\t\"metadata\": {\n\t\t\t\"version\": \"7\",\n\t\t\t\"created_at\": \"2018-10-10T14:16:21.667Z\",\n\t\t\t\"values\": {\n\t\t\t\t\"ref\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a_avatar_7\",\n\t\t\t\t\"name\": \"Stan\",\n\t\t\t\t\"url\": \"http://stan.to/\",\n\t\t\t\t\"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n\t\t\t}\n\t\t},\n\t\t\"inputs\": [\n\t\t\t{\n\t\t\t\t\"fulfills\": {\n\t\t\t\t\t\"transaction_id\": \"e456671ffd7e7093e758100189cf51742b0c680b9bd71c6f73a8a67f50279e73\",\n\t\t\t\t\t\"output_index\": 0\n\t\t\t\t},\n\t\t\t\t\"owners_before\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"fulfillment\": \"pGSAIAFa-Szbnr5RLwf4vc_-Lqrv4-mkuuFEyUi_J3zWk9A8gUB3n7t5Cf9Xls8EgA6mGDOWDlA_gIrU9JP7oBdvQOn20Bt4eH1zvmcDbH0nIhpegOZ17TPOEe6b1nmDH1cOqi8D\"\n\t\t\t}\n\t\t],\n\t\t\"outputs\": [\n\t\t\t{\n\t\t\t\t\"public_keys\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"condition\": {\n\t\t\t\t\t\"uri\": \"ni:///sha-256;HpCANV2iJLSvCg0UKqiXcaAvhRPxJIp5dh_G7HLDxCY?fpt=ed25519-sha-256&cost=131072\",\n\t\t\t\t\t\"details\": {\n\t\t\t\t\t\t\"type\": \"ed25519-sha-256\",\n\t\t\t\t\t\t\"public_key\": \"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"amount\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}\n"},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions/pending/{{id}}","description":"

Use Sign Pending Transaction to commit a signed transaction to underlying blockchain.

\n
Make sure to disable MFA for the ares user account associated to your application's client_id if you want to commit transactions unsupervised.\nAn alternative MFA method that can be integrated into automated / machine to machine [m2m] workflows will be added soon.
\n

On success status 201 Created is returned along with the header X-Ares-Created-Id holding the id of committed transaction on underlying blockchain. If MFA is enabled and further authorization is required, status 202 Accepted is returned. That is probably not what you want when you are committing transactions via the API, so make sure MFA is disabled for the user account associated to your application's client_id.

However if your application submitted a transaction on behalf of another user, you should not sign and submit it via the API, but instead redirect the user in a web browser to the authorization url that has been provided to you when you invoked Create Transaction or any other mutating endpoint.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}},"urlObject":{"protocol":"https","path":["alpha","transactions","pending","{{id}}"],"host":["fad7177qfa","execute-api","eu-central-1","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"1a1b3dcf-7f93-4189-b8fb-77901b20a46f","name":"Sign Transaction - Created","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"chain\": \"bdb\",\n\t\"scope\": \"root\",\n\t\"value\": {\n\t\t\"id\": \"6029d211fc0a2867c9eeb3e70b95c7a63d6d84b986f61121ebb61574c6b65f5a\",\n\t\t\"asset\": {\n\t\t\t\"id\": \"8304bd6557284fe98124389f834ab9b7a70e5cf436b490f35505dc497abf880a\"\n\t\t},\n\t\t\"operation\": \"TRANSFER\",\n\t\t\"version\": \"2.0\",\n\t\t\"metadata\": {\n\t\t\t\"version\": \"7\",\n\t\t\t\"created_at\": \"2018-10-10T14:16:21.667Z\",\n\t\t\t\"values\": {\n\t\t\t\t\"ref\": \"d9c2f9bd48a1e60539ff6fe6e25c501c103f5d93a90a3f5221b2734a_avatar_7\",\n\t\t\t\t\"name\": \"Stan\",\n\t\t\t\t\"url\": \"http://stan.to/\",\n\t\t\t\t\"image\": \"https://s3.eu-central-1.amazonaws.com/alpha-arena-avatars/6bc8fe7f049cc8b9c9e3f4e9d2a2e816e8887cfe2f8ea2de09536211dac32702f2fe84f043f8a8d355934b1d780097e6.gif\"\n\t\t\t}\n\t\t},\n\t\t\"inputs\": [\n\t\t\t{\n\t\t\t\t\"fulfills\": {\n\t\t\t\t\t\"transaction_id\": \"e456671ffd7e7093e758100189cf51742b0c680b9bd71c6f73a8a67f50279e73\",\n\t\t\t\t\t\"output_index\": 0\n\t\t\t\t},\n\t\t\t\t\"owners_before\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"fulfillment\": \"pGSAIAFa-Szbnr5RLwf4vc_-Lqrv4-mkuuFEyUi_J3zWk9A8gUB3n7t5Cf9Xls8EgA6mGDOWDlA_gIrU9JP7oBdvQOn20Bt4eH1zvmcDbH0nIhpegOZ17TPOEe6b1nmDH1cOqi8D\"\n\t\t\t}\n\t\t],\n\t\t\"outputs\": [\n\t\t\t{\n\t\t\t\t\"public_keys\": [\n\t\t\t\t\t\"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t],\n\t\t\t\t\"condition\": {\n\t\t\t\t\t\"uri\": \"ni:///sha-256;HpCANV2iJLSvCg0UKqiXcaAvhRPxJIp5dh_G7HLDxCY?fpt=ed25519-sha-256&cost=131072\",\n\t\t\t\t\t\"details\": {\n\t\t\t\t\t\t\"type\": \"ed25519-sha-256\",\n\t\t\t\t\t\t\"public_key\": \"6HsAoGSkTFyJeQqVyd2Es9RNNyzpTZ1t54j9KRFWsUo\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"amount\": \"1\"\n\t\t\t}\n\t\t]\n\t}\n}\n"},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/transactions/pending/e8b03420-cdfa-11e8-8e78-2de832d5ac92"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"X-Ares-Created-Id","value":"e8b03420-cdfa-11e8-8e78-2de832d5ac92","description":"","type":"text"},{"key":"Location","value":"https://d3ob2g5ep10o1o.cloudfront.net/account/transactions/authorize?transaction_id=e8b03420-cdfa-11e8-8e78-2de832d5ac92","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"HTTP/1.1 201 Created\nX-Ares-Created-Id: 6029d211fc0a2867c9eeb3e70b95c7a63d6d84b986f61121ebb61574c6b65f5a\n"}],"_postman_id":"08de676f-71f1-4690-97e3-adb8fadc39c0"}],"id":"93ea36b8-8dc9-4c27-ba12-e3e040be5cbc","_postman_id":"93ea36b8-8dc9-4c27-ba12-e3e040be5cbc","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","id":"1834fb4f-5096-4a06-aa24-5ee85cc6b9a5","name":"ares","type":"collection"}}},{"name":"Wallet","item":[{"name":"Ethereum Wallet","item":[{"name":"Resolve Balance - Root Chain","id":"ade1a546-51fb-4fe2-9083-3c623894589b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/wallet/eth/balance/root","description":"

Resolve ethereum wallet balance, denominated in Wei.

Either root or child

\n","key":"scope","type":"text","value":""},{"description":"

Recipient ethereum address

\n","key":"recipient","type":"text","value":""},{"description":"

Transfer amount, denominated in Wei

\n","key":"amount","type":"text","value":""},{"description":"

Message (optional)

\n","key":"message","type":"text","value":""}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/wallet/eth","description":"

Create Transfer prepares an unsigned (pending) transaction to transfer given amount of ETH, denominated in Wei, to given recipient. The parameter scope specifies whether you want to transfer staked funds on the child chain, or unstaked on the ethereum root chain. On success, status 201 Created is returned along with the headers X-Ares-Created-Id containing the id of the pending transaction as well as Location containing an authorization url for the pending transaction.

To actually sign & commit the transaction to the blockchain, the pending transaction must be resolved using provided id and signed & submitted to the transactions endpoint.

Un-/stake amount, denominated in Wei.

\n","type":"text"}]},"url":"https://fad7177qfa.execute-api.eu-central-1.amazonaws.com/alpha/wallet/eth","description":"

Update Stake prepares an unsigned (pending) transaction to deposit funds of the ethereum root chain to the ares child chain, and make them available for use with ares arena. Pass a negative amount to withdraw funds from the ares child chain back to the ethereum root chain. On success, status 201 Created is returned along with the headers X-Ares-Created-Id containing the id of the pending transaction as well as Location containing an authorization url for the pending transaction.

To actually sign & commit the transaction to the blockchain, the pending transaction must be resolved using provided id and signed & submitted to the transactions endpoint.