Kill the Clipboard - SMART Health Cards Library - v1.0.0
    Preparing search index...

    Interface SHLPayloadV1

    SHL Payload structure (v1).

    This is the core data structure that gets base64url-encoded in SHL URIs. Contains all information needed to access and decrypt SHL content.

    The payload is serialized as minified JSON and encoded as base64url in the SHL URI: shlink:/<base64url-encoded-payload>

    const payload: SHLPayloadV1 = {
      url: 'https://shl.example.org/manifests/abc123.../manifest.json',
      key: 'GawgguITVNvYokrepxQx_A663dZs3Q8a5_H2lBpxdUo', // 43 chars
      exp: 1640995200, // Unix timestamp
      flag: 'LP', // Long-term + passcode
      label: 'Lab Results - Dec 2021',
      v: 1
    };
    interface SHLPayloadV1 {
        exp?: number;
        flag?: SHLFlag;
        key: string;
        label?: string;
        url: string;
        v?: 1;
    }
    Index

    Properties

    exp? flag? key label? url v?

    Properties

    exp?: number

    Optional expiration time in Unix seconds. When present, SHL expires at this timestamp and should not be resolved.

    flag?: SHLFlag

    Optional flag string (concatenated single-character flags).

    key: string

    Symmetric encryption key (43 characters, base64url-encoded). 256-bit key used for JWE file encryption/decryption.

    label?: string

    Optional short description (max 80 characters). Human-readable label describing the shared content.

    url: string

    Manifest URL for this SHL. HTTPS URL where the manifest can be fetched via POST request.

    v?: 1

    Optional version (defaults to 1). SHL specification version, currently always 1.

    Settings

    Member Visibility

    On This Page

    Properties