cards.sunshine.card

sunshine.cards

Documentation

A Sunshine Card's public details. The record key is the card's UID.

main record

A Sunshine Card's public details. The record key is the card's UID.

Record Key any Any valid record key

Properties

back blob Optional

The card's back artwork: portrait, in ID-1 bank card proportions (53.98 × 85.60 mm).

maxSize: 1.0 MB
collection string Optional

The name of the collection this card is part of, like 'Autumn Market 2026'. Collections belong to the card's creator: two creators' collections with the same name are different collections.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
colors array of string Optional

The card's colours, most prominent first, each an sRGB hex colour like #f4b400.

maxLength: 3 items
counter integer Required

The tag's read counter at the last accepted tap.

minimum: 0maximum: 16777215
front blob Optional

The card's front artwork: portrait, in ID-1 bank card proportions (53.98 × 85.60 mm).

maxSize: 1.0 MB
record unknown Optional

An associated record, embedded whole.

uid string Required

The tag's serial number, as 14 upper-case hex characters.

maxLength: 14 bytesminLength: 14 bytes
url string uri Required

The URL anyone can visit when looking at this card collected in someone's account. It may be the same as the URL in the card's NFC (NDEF) record, or something different.

View raw schema 
{
  "description": "A Sunshine Card's public details. The record key is the card's UID.",
  "key": "any",
  "record": {
    "properties": {
      "back": {
        "accept": [
          "image/*"
        ],
        "description": "The card's back artwork: portrait, in ID-1 bank card proportions (53.98 × 85.60 mm).",
        "maxSize": 1000000,
        "type": "blob"
      },
      "collection": {
        "description": "The name of the collection this card is part of, like 'Autumn Market 2026'. Collections belong to the card's creator: two creators' collections with the same name are different collections.",
        "maxGraphemes": 64,
        "maxLength": 640,
        "type": "string"
      },
      "colors": {
        "description": "The card's colours, most prominent first, each an sRGB hex colour like #f4b400.",
        "items": {
          "maxLength": 7,
          "minLength": 7,
          "type": "string"
        },
        "maxLength": 3,
        "type": "array"
      },
      "counter": {
        "description": "The tag's read counter at the last accepted tap.",
        "maximum": 16777215,
        "minimum": 0,
        "type": "integer"
      },
      "front": {
        "accept": [
          "image/*"
        ],
        "description": "The card's front artwork: portrait, in ID-1 bank card proportions (53.98 × 85.60 mm).",
        "maxSize": 1000000,
        "type": "blob"
      },
      "record": {
        "description": "An associated record, embedded whole.",
        "type": "unknown"
      },
      "uid": {
        "description": "The tag's serial number, as 14 upper-case hex characters.",
        "maxLength": 14,
        "minLength": 14,
        "type": "string"
      },
      "url": {
        "description": "The URL anyone can visit when looking at this card collected in someone's account. It may be the same as the URL in the card's NFC (NDEF) record, or something different.",
        "format": "uri",
        "type": "string"
      }
    },
    "required": [
      "uid",
      "counter",
      "url"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@