From 0 to 1

General Information

๐Ÿ”— BASE URL

https://api.uproofs.apio.cc

๐Ÿ”‘ AUTHORIZATION

You can use your API KEY putting it inside the header

"Authorization": "apikey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

๐Ÿ‘ค Create an Identity

Description

This is the first endpoint to call, it generates the company and also the public and private key for the user, it is inserted in default identity and it will be used to send transaction to blockchain network. The default identity is an Ethereum Public and Private Key, this identity can be used on several network for example xDai, Ethereum Mainnet, Quorum, Artis and others Ethereum Codebase Blockchain.

The private key is encrypted with the API KEY and the API KEY is not saved in our database, there is only the md5 hash on database.

Request

ENDPOINT

POST "/identity"

BODY REQUEST

{
	"company":{
		"name": "ACME S.p.A.",
		"domain": "acme.it"
	}
}

๐Ÿ–ผ๏ธ Create an Asset

Description

An asset is the template for a series of proofs, for example if you want to certify Internet of Things data you can create an asset and use it to certify sensors data, several assets can be useful to create separate streams of proofs.

In the future we will develop several application on several Blockchain but at the moment it's only available:

  • Type: JSON

  • Application: timestamp useful to certify JSON data

  • Blockchain: xDai Proof of Stake public blockchain

Request

ENDPOINT

POST "/assets"

BODY

{
	"type": "JSON",
	"name": "Asset Name",
	"application": "timestamp",
	"description": "Assets Description",
	"backgroundImage": "url_image",
	"blockchain": "xDai"
}

๐Ÿงพ Create a Proof

Description

A proof is a core api, before create a proof you need to create an identity and asset because the proof will be signed with identity and receive from asset the structure for certification.

Request

ENDPOINT

POST "/proofs"

BODY

{
    "assetId": "fe602d7f-b807-4d65-bc29-23b4cea58bb7",
    "data": {
        "timestamp": "those",
        "data": "4ever"
    }
}

๐Ÿ” Verify with Trusty Proofs

This is an auto-generated page that can be used to demonstrate Proofs and Data. The following page is auto-generated for application timestamp.

Last updated