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

txId*string

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

Query parameters

Header parameters

Body

application/octet-stream

Record to be matched against the published record

string (byte)

Response

200400404500

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)

Body

text/plainapplication/jsontext/json

matchboolean

confirmationConfirmation (object)

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "match": false,
  "confirmation": {
    "confirmedBlocks": 0,
    "blockHash": "text",
    "blockTimestamp": "2024-12-22T04:03:36.557Z",
    "merkleProof": {
      "index": 0,
      "txOrId": "text",
      "target": "text",
      "nodes": [
        "text"
      ],
      "targetType": "text",
      "proofType": "text",
      "composite": false
    }
  }
}