Get record

Retrieve a single record by its watermark ID. This endpoint is public.

GET /api/records/{wm_id}

Get record

cURL

curl --request GET \
  --url https://yys-sqr-render-bsbe.onrender.com/api/records/{wm_id}

200

{
  "watermark_id": "SQR-A1B2C",
  "template_id": "pharma",
  "claim_status": "unclaimed",
  "description": "<string>",
  "record_metadata": {
    "product_name": "Aspirin",
    "dosage": "100mg"
  },
  "image_url": "<string>",
  "watermarked_image_url": "<string>",
  "scan_count": 0,
  "nft_token_id": 123,
  "mint_transaction_hash": "<string>",
  "owner_address": "<string>",
  "claimed_by": "<string>",
  "claim_transaction_hash": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "minted_at": "2023-11-07T05:31:56Z",
  "claimed_at": "2023-11-07T05:31:56Z"
}

Path Parameters

wm_id · string · required

Response

200

application/json

Record detail

watermark_id · string

Example:

"SQR-A1B2C"

template_id · string

Example:

"pharma"

claim_status · enum<string>

Available options: unclaimed, minted, claimed

Example:

"unclaimed"

description · string | null

record_metadata · object

Show child attributes

Example:

{
  "product_name": "Aspirin",
  "dosage": "100mg"
}

image_url · string | null

watermarked_image_url · string | null

scan_count · integer

Example:

0

nft_token_id · integer | null

mint_transaction_hash · string | null

owner_address · string | null

claimed_by · string | null

claim_transaction_hash · string | null

created_at · string<date-time>

updated_at · string<date-time>

minted_at · string<date-time> | null

claimed_at · string<date-time> | null