{"info":{"_postman_id":"29026542-e65e-4e4b-adbd-79cfefff0e9d","name":"Propre API","description":"

The Propre API allows users to create Merkle trees and upload the hash to the bitcoin test network. It also allows users to verify their uploaded files.

\n

Propre Website

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15691586","collectionId":"29026542-e65e-4e4b-adbd-79cfefff0e9d","publishedId":"TzRVekwe","public":true,"customColor":{"top-bar":"c1c1c1","right-sidebar":"303030","highlight":"616161"},"publishDate":"2021-05-14T01:12:42.000Z"},"item":[{"name":"Proof","id":"c0d2d4a6-24d0-4845-aa1f-3152b5298386","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Email ID\" : \"\",\r\n \"Files\" : {\r\n \"yeah.txt\": \"c0d801940c8bcdb56fc8ea54f24e21c02629f6a987bc520541717afbc2fb046b\",\r\n \"hello.txt\": \"b57c370a0fcc704562e14bc1765dfc6e573fde46ebfda7c229e9f429b5f5697a\"\r\n }\r\n}"},"url":"https://propre-api.herokuapp.com/propre-api/proof","description":"

This POST request allows users to create a Merkle tree and upload the encrypted root hash to the bitcoin test network.

\n

The request is sent with JSON data in the body.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyData TypeRequirementStructureExample
FilesdictRequiredfile name, file hash as key, value{ \"yeah.txt\": \"c0d801940c8bcdb56fc8ea54f24e21c02629f6a987bc520541717afbc2fb046b\",
\"hello.txt\": \"b57c370a0fcc704562e14bc1765dfc6e573fde46ebfda7c229e9f429b5f5697a\" }
Email IDstringOptional\"xxx@yyy.com\"
\n

The returned data is in JSON format.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyData TypeReturned WhenStructureExample
StatusbooleanAlwaystrue
Files PathdictWhen Status is truefile name, file path as key, value{\"hello.txt\": \"c0d801940c8bcdb56fc8ea54f24e21c02629f6a987bc520541717afbc2fb046b\", \"yeah.txt\": \"b57c370a0fcc704562e14bc1765dfc6e573fde46ebfda7c229e9f429b5f5697a\" }
TransactiondictWhen Status is true{ \"txid\" : transaction ID, \"blockchain\" : link to transaction }{\"blockchain\": \"https://www.blockchain.com/btc-testnet/tx/29843bc2586488edca9a0cbbbe35952e3922b1a93eea20cda61672fcbb388044\", \"txid\": \"29843bc2586488edca9a0cbbbe35952e3922b1a93eea20cda61672fcbb388044\" }
ErrorstringWhen Status is false\"Different Number of Files and Hashes.\"
\n
","urlObject":{"protocol":"https","path":["propre-api","proof"],"host":["propre-api","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0d2d4a6-24d0-4845-aa1f-3152b5298386"},{"name":"Verify","id":"dbe1a190-101f-4498-9f45-d2181ea58440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://propre-api.herokuapp.com/propre-api/verify","description":"

This GET request allows users to verify a file on a transaction in the bitcoin test network.

\n

The parameters in this request are sent as headers. All of them are required for the API call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyData TypeReturned WhenExample
StatusbooleanAlwaystrue
verifybooleanWhen Status is truefalse
ErrorstringWhen Status is false\"No Path Provided.\"
\n
","urlObject":{"protocol":"https","path":["propre-api","verify"],"host":["propre-api","herokuapp","com"],"query":[{"disabled":true,"key":"txid","value":"2b27e2ea9c3dd784ee09488e777b8194c7a20bda80286d4db7b722e170a4f474"},{"disabled":true,"key":"path","value":"c0d801940c8bcdb56fc8ea54f24e21c02629f6a987bc520541717afbc2fb046b"},{"disabled":true,"key":"hash","value":"b57c370a0fcc704562e14bc1765dfc6e573fde46ebfda7c229e9f429b5f5697a"}],"variable":[]}},"response":[],"_postman_id":"dbe1a190-101f-4498-9f45-d2181ea58440"}]}