pass
Something the user shows: a ticket, a boarding pass, a pickup code, a coupon.
Something to show. pass is what the user holds up at a counter or a gate: a ticket, a boarding pass, a pickup code, a coupon, a membership card — a title, a few fields (gate, seat, time), and a code.
The code is drawn by the server from its value, as a QR, Code 128, PDF417 or Aztec code, and reaches the SDK as modules to paint at full size with a quiet zone; the model's own block never carries it. With wallet links, the pass offers Add to Apple Wallet or Save to Google Wallet.
Re-rendered in the browser from the SDK’s own scales. Not a screenshot.
What the server checks
The code's value and the wallet links have to be exactly what one of your actions returned: a made-up barcode is a forged ticket.
Props
Every block also carries type and a required fallback_text of 1 to 300 characters.
| Prop | Type | Required | Constraints |
|---|---|---|---|
kind | boarding | ticket | pickup | coupon | membership | Yes | None |
title | string | Yes | 1 to 80 characters. |
subtitle | string | No | Up to 120 characters. |
fields | array | No | Up to 8 entries. |
fields[].label | string | Yes | 1 to 30 characters. |
fields[].value | string | Yes | 1 to 60 characters. |
code | object | No | None |
code.format | qr | code128 | pdf417 | aztec | Yes | None |
code.value | string | Yes | 1 to 500 characters. |
code.display_text | string | No | Up to 60 characters. |
code.matrix | object | No | None |
code.matrix.rows | integer | Yes | 1 to 200. |
code.matrix.cols | integer | Yes | 1 to 200. |
code.matrix.bits | string | Yes | Up to 8000 characters. |
code.matrix.module_aspect | number | Yes | 1 to 4. |
code.bars | integer[] | No | Up to 600 whole numbers, 1 to 4 each. |
wallet | object | No | None |
wallet.apple_pkpass_url | string | No | None |
wallet.google_save_url | string | No | None |
valid_until | string | No | ISO 8601 in UTC (...Z); a numeric offset fails validation. |