Functional Description

The LinkedRecords REST API provides endpoint that enable you to:

  • Create Link Record: Write a link record to the blockchain. The API request returns the link location of the record on the blockchain, which can be subsequently linked to another link location.

  • Read Link Record: Obtain the record and its status from the link location on the blockchain. The status will include information such as the next and previous link locations and whether this link location is updateable or not.

  • Update Link Record: Logically update the record at the link location. The API request returns the new link location of the new record on the blockchain.

  • Delete Link Record: Logically delete the link location by writing an empty record to the blockchain. The previous link location is linked to this empty record, thus terminating the linked locations. The API request returns the new link location of the empty record on the blockchain.

  • Verify Link Record: Verify whether the record matches the one at the link location on the blockchain. This includes verifying the relevant link information (create, update or delete).