Status

Get record status

get

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

Path parameters

txIdstringRequired

The transaction id of the record to query. Using a value other than a id returned by write record produces undefined behavior.

Header parameters

x-api-keystringRequired

{your-API-key}

Responses

200

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 (set on a best-effort basis) - merkleProof: A JSON object as defined in TSC Merkle Proof (https://tsc.bsvblockchain.org/standards/merkle-proof-standardised-format/#JSONform)

400

Invalid request. The response is a JSON structure conforming to https://tools.ietf.org/html/rfc7807. It contains the following details: - errorCode: which can be one of: - TX_ID_PARAM_INVALID: Provided transaction id parameter is not a valid blockchain transaction id

404

The transaction cannot be read from the blockchain. It could either still be in the process of publishing or the blockchain has rejected it.

500

An internal error occurred. Retry later. The Response is a JSON structure conforming to https://tools.ietf.org/html/rfc7807

get

GET /api/v1/records/{txId}/status HTTP/1.1
Host: {your-URL}
x-api-key: text
Accept: */*

{
  "confirmation": {
    "confirmedBlocks": 1,
    "blockHash": "text",
    "blockTimestamp": "2025-05-09T11:41:44.428Z",
    "merkleProof": {
      "index": 1,
      "txOrId": "text",
      "target": "text",
      "nodes": [
        "text"
      ],
      "targetType": "text",
      "proofType": "text",
      "composite": true
    }
  }
}