Match

Verify record

Verify whether the supplied record matches the published record. The response indicates whether the records match, mismatch or there is an error.

post

{your-URL}/api/v1/records/{txId}/match

Path parameters

txIdstringrequired

The transaction id of the record to verify. Using an id other than one returned by write record produces undefined behavior.

Query parameters

encodestringrequired

The same encode parameters as used to create the record. In the case of encoders used without a "salt" parameter, this can be omitted.

Header parameters

x-api-keystringrequired

{your-API-key}

Body

string · byte

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '{your-URL}/api/v1/records/{txId}/match?encode=text' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/octet-stream'

200

400

404

500

200

text/plain

application/json

text/json

text/plain

{
  "match": true,
  "confirmation": {
    "confirmedBlocks": 1,
    "blockHash": "text",
    "blockTimestamp": "2025-02-22T23:29:20.302Z",
    "merkleProof": {
      "index": 1,
      "txOrId": "text",
      "target": "text",
      "targetType": "text",
      "proofType": "text",
      "composite": true,
      "nodes": [
        "text"
      ]
    }
  }
}

The transaction has been published. The Response is a JSON structure containing:

• match: boolean indicating whether the supplied record matches the published record
• confirmation: set if transaction has been included in a valid block (same as with get status endpoint)
  • 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)