Share an Address

Basic Description

This endpoint is used to share an address in Taurus-NETWORK. An address may be shared with any participant of Taurus-NETWORK, so long as said participant has the blockchain in question enabled.

This endpoint would accept a POST request with a JSON payload containing details of who to share to and which address. The toParticipantID and addressID are the only two required parameters that must be included within the JSON payload.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.

Here is the list of required Roles for this particular endpoint:

• TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

Certain API endpoints require specific input parameters. Here is the list of Required Input Parameters for this particular endpoint:

• toParticipantID: the id of the participant the address will be shared with.
• addressID: The id of the address to be shared.

📘

Preconditions

There are no preconditions for the address sharing process.

Call Example

You can find a basic example in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/tn/shared_addresses" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \
--data '{
  "toParticipantID": "064c84f1-d9d2-4160-86c1-2d81c3ac9c1f",
  "addressID": "5"
}'

This piece of code sends a POST request to https://your-protect-instance.example.com/api/rest/v1/tn/shared_addresses with the JSON string in the request body.

👍

Call Result

A successful response for the POST call to share an address might look like this:

{}

In this example, Taurus-PROTECT has made a share request to a participant of Taurus-NETWORK.

Requirements for Future Use

For this particular endpoint, we do not have any storage requirements.

You can find the Swagger-generated page for this endpoint in the following link.