Status

Get linked record status

Get the current state of a linked record that was written to the blockchain. It takes a few minutes before any transaction is confirmed to be on the blockchain.

get

{your-URL}/api/v1/linkedrecords/{txId}/status

Path parameters

txIdstringrequired

The transaction id of the linked record to query. Using a value other than one returned by the LinkedRecords methods produces undefined behavior.

Header parameters

x-api-keystringrequired

{your-API-key}

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '{your-URL}/api/v1/linkedrecords/{txId}/status' \
  --header 'x-api-key: text'

200

400

404

500

200

text/plain

application/json

text/json

text/plain

{
  "confirmation": {
    "confirmedBlocks": 1,
    "blockHash": "text",
    "blockTimestamp": "2025-02-22T17:38:43.859Z",
    "merkleProof": {
      "index": 1,
      "txOrId": "text",
      "target": "text",
      "targetType": "text",
      "proofType": "text",
      "composite": true,
      "nodes": [
        "text"
      ]
    }
  },
  "updatable": true
}

The transaction has been published. The response is an application/json structure containing:

• confirmation: set if transaction has been included in a valid block
  • confirmedBlocks: Number of confirmations (blocks) at the time of request
  • blockHash: block hash if transaction has been included in a block
  • blockTimestamp: block header timestamp (field is set on best-effort basis)
  • merkleProof: A JSON object as defined in TSC Merkle Proof (https://tsc.bsvblockchain.org/standards/merkle-proof-standardised-format/#JSONform)
• updatable: true if published and linked record can be updated