Linkedrecords

Create linked record

Create a linked record transaction.

The transaction will be published to the blockchain asynchronously. Use Get linked record status to find out when it has been confirmed.

POST{your-URL}/api/v1/linkedrecords

Query parameters

Header parameters

Body

application/octet-stream

Record to be included in the transaction output as an application/octet-stream

string (byte)

Response

200400500

The transaction has been published. The response is a JSON structure, containing the following details:

• txId: the transaction Id which is required by subsequent commands and can also be used by external tools
• encoding: array of encoding steps (omitted when encoders are not used), each element defines:
  • contentType: output content type
  • output: if content type is a text, it will include up to 1024 characters of the output (omitted for other content types)
• update_token: URL encoded JSON Structure containing:
  • key alias
  • key derivation path
  • locking script
  • output value

Body

text/plainapplication/jsontext/json

txIdnullable string

updateTokennullable string

fingerprintnullable string (byte)

Request

JavaScriptCurlPython

const response = await fetch('{your-URL}/api/v1/linkedrecords', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/octet-stream"
    },
    body: JSON.stringify("Ynl0ZXM="),
});
const data = await response.json();

Response

200400500

{
  "txId": "text",
  "updateToken": "text",
  "fingerprint": "Ynl0ZXM="
}