Skip to main content

Pass

hotel objectrequired
oneOf
wallet objectrequired
oneOf
namestringrequired
logostringrequired
iconstringrequired
androidLogostring
displayIdentifiantbooleanrequired
passBuilderPassTemplateIdstring
passBuilderBusinessIdstring
passBuilderTokenstring
identifierstringrequired
identifierQrstringrequired
addressstring
websitestringrequired
servicePhonestringrequired
businessPhonestringrequired
socialMedia objectrequired
linkedinstring
facebookstring
instagramstring
tiktokstring
twitterstring
youtubestring
snapchatstring
pintereststring
redditstring
whatsappstring
telegramstring
additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    titlestringrequired
    hotelNamestring
    descriptionstring
    stripstring
    codestring
    advantagesstring[]required
    colors object
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    barcodeFormatstring

    Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    passBuilderPassTemplateIdstring
    location object
    longitudenumber
    latitudenumber
    relevantNamestring
    relevantAddressstring
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    client object
    oneOf
    walletstring
    clientType object
    oneOf
    storeCard objectrequired
    oneOf
    wallet objectrequired
    oneOf
    namestringrequired
    logostringrequired
    iconstringrequired
    androidLogostring
    displayIdentifiantbooleanrequired
    passBuilderPassTemplateIdstring
    passBuilderBusinessIdstring
    passBuilderTokenstring
    identifierstringrequired
    identifierQrstringrequired
    addressstring
    websitestringrequired
    servicePhonestringrequired
    businessPhonestringrequired
    socialMedia objectrequired
    linkedinstring
    facebookstring
    instagramstring
    tiktokstring
    twitterstring
    youtubestring
    snapchatstring
    pintereststring
    redditstring
    whatsappstring
    telegramstring
    additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    cardTypestringrequired

    Possible values: [STORE_CARD, MEMBER_CARD]

    displayIdentifiantbooleanrequired
    displayWalletNameboolean
    stripstringrequired
    passBuilderPassTemplateIdstring
    programNamestring
    keysHasChangedstring[]
    startRowstring

    Possible values: [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

    middleRowstring

    Possible values: [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

    endRowstring

    Possible values: [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

    iosHeader object
    labelEnumstringrequired

    Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

    valueEnumstringrequired

    Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

    customLabelstring
    customValuestring
    barcodeTypestringrequired

    Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    descriptions object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
  • ]
    • openingHoursstringrequired
    colors objectrequired
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    oneTimeToUsebooleanrequired
    sharingProhibitedbooleanrequired
    sharingProhibitedAndroidbooleanrequired
    validity objectrequired
    expirationTypestringrequired

    Possible values: [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]

    expirationDatestring<date-time>
    expirationAfterPeriodstring
    expirationPeriodTypestring

    Possible values: [YEARS, MONTHS, WEEKS]

    expirationOptionstring

    Possible values: [AT_CREATION_DATE, END_OF_MONTH]

    gainLabelstringrequired

    Possible values: [GAIN, GAINS, CAGNOTE, POINTS]

    gainUnitstringrequired

    Possible values: [NONE, EURO, USD, MAD, POINTS]

    offerLabelstringrequired
    enableDisplayIdentifiantbooleanrequired
    gainFormatMigratedbooleanrequired

    Marks whether the PassBuilder template and all existing passes have been migrated to the new gain format where the unit symbol is embedded in the pass attribute value (e.g. "50 Pts") rather than in the template field. False (or absent) means the old format is still in use.

    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    namestringrequired
    isDefaultbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    sourcestringrequired

    Possible values: [CRM, INTERNAL, EXTERNAL]

    barcodestring
    firstNamestringrequired
    lastNamestringrequired
    emailstring
    companyNamestring
    renewalDatestring<date-time>
    phoneNumberstring
    birthDatestring<date-time>
    admissionDatestring<date-time>
    gainnumber
    gainHistory object[]
  • Array [
    • gainnumberrequired
    datestring<date-time>required
  • ]
    • communicationPreferences object[]

    Per-event, per-channel communication preference overrides for this client (GDPR consent management). Same shape as WalletSetting.communicationRules — reused rather than duplicated. No entry for a given notificationType means enabled, mirroring isCommunicationRuleEnabled's existing semantics. Change history is intentionally NOT embedded here — see CommunicationPreferenceLog — to keep this frequently-read document small.

  • Array [
    • notificationTypestringrequired

    Possible values: [NEW_LOYALTY, UPDATE_LOYALTY, REMINDER_LOYALTY, EARNINGS_UPDATE, NEW_COMMUNICATION, EXPIRED_COMMUNICATION, NEW_EVENT, UPDATE_EVENT, NEW_COUPON, UPDATE_COUPON, WELCOME_INTERNAL_CLIENTS, WELCOME_CRM_CLIENTS, WELCOME_EXTERNAL_CLIENTS, WELCOME_COUPON, EXPIRED_COUPON, TRANSIT_TICKET, UPDATE_TRANSIT, HOTEL_RESERVATION, UPDATE_HOTEL_RESERVATION, CINEMA_TICKET]

    smsbooleanrequired
    emailbooleanrequired
    notificationbooleanrequired
  • ]
    • pushInformativeEnabledboolean

    Opt-out of manager-created "standard" push campaigns classified as informative.

    pushCommercialEnabledboolean

    Opt-out of manager-created "standard" push campaigns classified as commercial.

    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    transit object
    oneOf
    wallet objectrequired
    oneOf
    namestringrequired
    logostringrequired
    iconstringrequired
    androidLogostring
    displayIdentifiantbooleanrequired
    passBuilderPassTemplateIdstring
    passBuilderBusinessIdstring
    passBuilderTokenstring
    identifierstringrequired
    identifierQrstringrequired
    addressstring
    websitestringrequired
    servicePhonestringrequired
    businessPhonestringrequired
    socialMedia objectrequired
    linkedinstring
    facebookstring
    instagramstring
    tiktokstring
    twitterstring
    youtubestring
    snapchatstring
    pintereststring
    redditstring
    whatsappstring
    telegramstring
    additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    barcodeFormatstringrequired

    Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    termsstringrequired
    emailSubscriptionMessagestring
    subscriptionMessagestring
    locations object[]
  • Array [
    • longitudenumber
    latitudenumber
    relevantNamestring
    relevantAddressstring
  • ]
    • colors objectrequired
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    stripstring
    customerServiceNumberstring
    originStationCodestringrequired
    originNamestringrequired
    destinationStationCodestringrequired
    destinationNamestringrequired
    departureTimestringrequired
    arrivalTimestringrequired
    tarifstring
    detailsstringrequired
    numberstringrequired
    typestringrequired

    Possible values: [Bus, Boat, Train, Air, Generic, Tram]

    gateNamestring

    Possible values: [N_CABINE, N_VOYAGE, PLAQUE]

    seatNamestring

    Possible values: [N_CABINE, N_VOYAGE, PLAQUE]

    security object
    enableOneTimeUseboolean
    disableIOSPassSharingboolean
    disablePassLinkSharingboolean
    disableMultipleHoldersboolean
    enableSecurityAnimationboolean
    enableRotatingBarcodeboolean
    passBuilderPassTemplateIdstring
    customBackFieldsstring[]

    Template-level back field definitions (key + label + type). Per-pass values live on the Pass document.

    displayOptions object
    hideTarifboolean
    hideStationCodesboolean
    hideTripNumberboolean
    iosHeader object
    labelEnumstringrequired

    Possible values: [FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE]

    valueEnumstringrequired

    Possible values: [FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE]

    customLabelstring
    customValuestring
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    event object
    oneOf
    statusEventStatusrequired

    Possible values: [PENDING, ACTIF, ENDED]

    Default value: PENDING
    wallet objectrequired
    oneOf
    namestringrequired
    logostringrequired
    iconstringrequired
    androidLogostring
    displayIdentifiantbooleanrequired
    passBuilderPassTemplateIdstring
    passBuilderBusinessIdstring
    passBuilderTokenstring
    identifierstringrequired
    identifierQrstringrequired
    addressstring
    websitestringrequired
    servicePhonestringrequired
    businessPhonestringrequired
    socialMedia objectrequired
    linkedinstring
    facebookstring
    instagramstring
    tiktokstring
    twitterstring
    youtubestring
    snapchatstring
    pintereststring
    redditstring
    whatsappstring
    telegramstring
    additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    barcodeTypestringrequired

    Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    namestringrequired
    locations object[]required
  • Array [
    • longitudenumber
    latitudenumber
    addressstring
    locationNamestring
  • ]
    • date object
    startDatestring<date-time>
    endDatestring<date-time>
    doorOpeningHourstring<date-time>
    pricenumber
    gainUnitstring

    Possible values: [NONE, EURO, USD, MAD, POINTS]

    descriptionstring
    termsstring
    subscriptionMessagestringrequired
    emailSubscriptionMessagestringrequired
    contactPhonestring
    emailstring
    websitestring
    colors objectrequired
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    security object
    enableOneTimeUseboolean
    disableIOSPassSharingboolean
    disablePassLinkSharingboolean
    disableMultipleHoldersboolean
    enableSecurityAnimationboolean
    enableRotatingBarcodeboolean
    passBuilderPassTemplateIdstring
    stripstring
    PKTextAlignmentLeftstring

    Possible values: [CHAIR, ACCESS, PRICE, ZONE, INACTIVE]

    PKTextAlignmentCenterstring

    Possible values: [ROW, INACTIVE]

    PKTextAlignmentRightstring

    Possible values: [INACTIVE, TYPE, SEAT, PLACE, ARMCHAIR, LOCATION, PORT]

    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    storeCard object
    oneOf
    wallet objectrequired
    oneOf
    namestringrequired
    logostringrequired
    iconstringrequired
    androidLogostring
    displayIdentifiantbooleanrequired
    passBuilderPassTemplateIdstring
    passBuilderBusinessIdstring
    passBuilderTokenstring
    identifierstringrequired
    identifierQrstringrequired
    addressstring
    websitestringrequired
    servicePhonestringrequired
    businessPhonestringrequired
    socialMedia objectrequired
    linkedinstring
    facebookstring
    instagramstring
    tiktokstring
    twitterstring
    youtubestring
    snapchatstring
    pintereststring
    redditstring
    whatsappstring
    telegramstring
    additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    cardTypestringrequired

    Possible values: [STORE_CARD, MEMBER_CARD]

    displayIdentifiantbooleanrequired
    displayWalletNameboolean
    stripstringrequired
    passBuilderPassTemplateIdstring
    programNamestring
    keysHasChangedstring[]
    startRowstring

    Possible values: [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

    middleRowstring

    Possible values: [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

    endRowstring

    Possible values: [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

    iosHeader object
    labelEnumstringrequired

    Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

    valueEnumstringrequired

    Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

    customLabelstring
    customValuestring
    barcodeTypestringrequired

    Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    descriptions object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
  • ]
    • openingHoursstringrequired
    colors objectrequired
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    oneTimeToUsebooleanrequired
    sharingProhibitedbooleanrequired
    sharingProhibitedAndroidbooleanrequired
    validity objectrequired
    expirationTypestringrequired

    Possible values: [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]

    expirationDatestring<date-time>
    expirationAfterPeriodstring
    expirationPeriodTypestring

    Possible values: [YEARS, MONTHS, WEEKS]

    expirationOptionstring

    Possible values: [AT_CREATION_DATE, END_OF_MONTH]

    gainLabelstringrequired

    Possible values: [GAIN, GAINS, CAGNOTE, POINTS]

    gainUnitstringrequired

    Possible values: [NONE, EURO, USD, MAD, POINTS]

    offerLabelstringrequired
    enableDisplayIdentifiantbooleanrequired
    gainFormatMigratedbooleanrequired

    Marks whether the PassBuilder template and all existing passes have been migrated to the new gain format where the unit symbol is embedded in the pass attribute value (e.g. "50 Pts") rather than in the template field. False (or absent) means the old format is still in use.

    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    wallet object
    oneOf
    namestringrequired
    logostringrequired
    iconstringrequired
    androidLogostring
    displayIdentifiantbooleanrequired
    passBuilderPassTemplateIdstring
    passBuilderBusinessIdstring
    passBuilderTokenstring
    identifierstringrequired
    identifierQrstringrequired
    addressstring
    websitestringrequired
    servicePhonestringrequired
    businessPhonestringrequired
    socialMedia objectrequired
    linkedinstring
    facebookstring
    instagramstring
    tiktokstring
    twitterstring
    youtubestring
    snapchatstring
    pintereststring
    redditstring
    whatsappstring
    telegramstring
    additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    coupon object
    oneOf
    wallet objectrequired
    oneOf
    namestringrequired
    logostringrequired
    iconstringrequired
    androidLogostring
    displayIdentifiantbooleanrequired
    passBuilderPassTemplateIdstring
    passBuilderBusinessIdstring
    passBuilderTokenstring
    identifierstringrequired
    identifierQrstringrequired
    addressstring
    websitestringrequired
    servicePhonestringrequired
    businessPhonestringrequired
    socialMedia objectrequired
    linkedinstring
    facebookstring
    instagramstring
    tiktokstring
    twitterstring
    youtubestring
    snapchatstring
    pintereststring
    redditstring
    whatsappstring
    telegramstring
    additionalContacts object[]required
  • Array [
    • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
    • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    barcodeFormatstringrequired

    Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    namestringrequired
    descriptionstringrequired
    promoCodestring
    valuestring
    expirationDatestring<date-time>
    isMultipleInstancebooleanrequired
    isWelcomeCouponbooleanrequired
    statusstringrequired

    Possible values: [ACTIVE, INACTIVE, EXPIRED]

    sourcestringrequired

    Possible values: [INTERNAL, EXTERNAL, CRM, ALL]

    colors objectrequired
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    stripstring
    emailSubscriptionMessagestring
    subscriptionMessagestring
    security object
    oneTimeToUseJwtLinkbooleanrequired
    disableIOSPassSharingboolean
    enableOneTimeUseboolean
    disableMultipleHoldersboolean
    enableSecurityAnimationboolean
    enableRotatingBarcodeboolean
    valueLabelstringrequired

    Possible values: [VALUE, AMOUNT, PRESTATION]

    iosHeader object
    labelEnumstringrequired

    Possible values: [FULLNAME, CUSTOM_TEXT, INACTIVE]

    valueEnumstringrequired

    Possible values: [FULLNAME, CUSTOM_TEXT, INACTIVE]

    customLabelstring
    customValuestring
    passBuilderPassTemplateIdstring
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    passBuilderPassIdstring
    passBuilderUpdatedAtstring<date-time>
    shortIdstring

    4-char unique id for short links (base62), auto-generated on insert

    legacyShortIdstring

    V1 shortlinks.shortLinkId preserved for /p/:id redirects (variable length)

    kindstringrequired

    Possible values: [hotel, transit, event, storeCard, coupon]

    firstNamestring
    lastNamestring
    emailstring
    barcodestring
    phoneNumberstring
    devices object[]required
  • Array [
    • deviceLibraryIdentifierstringrequired
    deviceTypestringrequired

    Possible values: [ANDROID, IOS]

    registeredAtstring<date-time>required
    isDeletedbooleanrequired
  • ]
    • activeIOSDeviceCountnumberrequired
    activeAndroidDeviceCountnumberrequired
    statusstringrequired

    Possible values: [active, inactive, deleted, canceled, expired]

    redeemedAtstring<date-time>
    instanceId object
    object
    instanceLinks object[]required
  • Array [
    • instanceIdstringrequired
    linkstringrequired
    namestring
    descriptionstring
  • ]
    • checkinstring<date-time>
    checkoutstring<date-time>
    additionalBenefitsstring[]
    roomNumberstring
    roomCodestring
    gatestring
    seatstring
    originNamestring
    destinationNamestring
    originStationCodestring
    destinationStationCodestring
    departureTimestring
    arrivalTimestring
    tarifstring
    tripNumberstring
    departureDatestringrequired
    arrivalDatestringrequired
    expirationDatestring<date-time>
    originalExpirationDatestring<date-time>

    Stashed validity date before manual EXPIRED overwrites expirationDate

    admissionDatestring<date-time>
    backFieldNamestring
    backFieldContentstring
    customBackFieldsstring[]

    Transit-specific structured back fields (replaces the scalar backFieldName/backFieldContent for transit passes)

    leftRowstring
    centerRowstring
    rightRowstring
    promoCodestring
    valuestring
    unitstring
    descriptionstring
    bannerOverrideUrlstring
    downloadedViaobjectnullable
    shortLinkstring

    Short link for the pass inscription page (e.g. for QR codes) (not in database, computed on the fly)

    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    Pass
    {
      "hotel": {
        "wallet": {
          "name": "string",
          "logo": "string",
          "icon": "string",
          "androidLogo": "string",
          "displayIdentifiant": true,
          "passBuilderPassTemplateId": "string",
          "passBuilderBusinessId": "string",
          "passBuilderToken": "string",
          "identifier": "string",
          "identifierQr": "string",
          "address": "string",
          "website": "string",
          "servicePhone": "string",
          "businessPhone": "string",
          "socialMedia": {
            "linkedin": "string",
            "facebook": "string",
            "instagram": "string",
            "tiktok": "string",
            "twitter": "string",
            "youtube": "string",
            "snapchat": "string",
            "pinterest": "string",
            "reddit": "string",
            "whatsapp": "string",
            "telegram": "string"
          },
          "additionalContacts": [
            {
              "title": "string",
              "value": "string",
              "kind": "URL"
            }
          ],
          "termsAndConditions": {
            "type": "PDF",
            "customUrl": "string",
            "pdfUrl": "string"
          },
          "webHookUrl": "string",
          "rootDomain": "string",
          "timezone": "string",
          "allowedPasses": [
            "ALL"
          ],
          "expiredCleanupEnabled": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "title": "string",
        "hotelName": "string",
        "description": "string",
        "strip": "string",
        "code": "string",
        "advantages": [
          "string"
        ],
        "colors": {
          "labelColor": "string",
          "backgroundColor": "string",
          "foregroundColor": "string"
        },
        "barcodeFormat": "AZTEC",
        "passBuilderPassTemplateId": "string",
        "location": {
          "longitude": 0,
          "latitude": 0,
          "relevantName": "string",
          "relevantAddress": "string"
        },
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "client": {
        "wallet": "string",
        "clientType": {
          "storeCard": {
            "wallet": {
              "name": "string",
              "logo": "string",
              "icon": "string",
              "androidLogo": "string",
              "displayIdentifiant": true,
              "passBuilderPassTemplateId": "string",
              "passBuilderBusinessId": "string",
              "passBuilderToken": "string",
              "identifier": "string",
              "identifierQr": "string",
              "address": "string",
              "website": "string",
              "servicePhone": "string",
              "businessPhone": "string",
              "socialMedia": {
                "linkedin": "string",
                "facebook": "string",
                "instagram": "string",
                "tiktok": "string",
                "twitter": "string",
                "youtube": "string",
                "snapchat": "string",
                "pinterest": "string",
                "reddit": "string",
                "whatsapp": "string",
                "telegram": "string"
              },
              "additionalContacts": [
                {
                  "title": "string",
                  "value": "string",
                  "kind": "URL"
                }
              ],
              "termsAndConditions": {
                "type": "PDF",
                "customUrl": "string",
                "pdfUrl": "string"
              },
              "webHookUrl": "string",
              "rootDomain": "string",
              "timezone": "string",
              "allowedPasses": [
                "ALL"
              ],
              "expiredCleanupEnabled": true,
              "_id": "string",
              "createdAt": "2024-07-29T15:51:28.071Z",
              "updatedAt": "2024-07-29T15:51:28.071Z"
            },
            "cardType": "STORE_CARD",
            "displayIdentifiant": true,
            "displayWalletName": true,
            "strip": "string",
            "passBuilderPassTemplateId": "string",
            "programName": "string",
            "keysHasChanged": [
              "string"
            ],
            "startRow": "CREATION_DATE",
            "middleRow": "CREATION_DATE",
            "endRow": "CREATION_DATE",
            "iosHeader": {
              "labelEnum": "TYPE",
              "valueEnum": "TYPE",
              "customLabel": "string",
              "customValue": "string"
            },
            "barcodeType": "AZTEC",
            "descriptions": [
              {
                "title": "string",
                "value": "string"
              }
            ],
            "openingHours": "string",
            "colors": {
              "labelColor": "string",
              "backgroundColor": "string",
              "foregroundColor": "string"
            },
            "oneTimeToUse": true,
            "sharingProhibited": true,
            "sharingProhibitedAndroid": true,
            "validity": {
              "expirationType": "NO_EXPIRATION",
              "expirationDate": "2024-07-29T15:51:28.071Z",
              "expirationAfterPeriod": "string",
              "expirationPeriodType": "YEARS",
              "expirationOption": "AT_CREATION_DATE"
            },
            "gainLabel": "GAIN",
            "gainUnit": "NONE",
            "offerLabel": "string",
            "enableDisplayIdentifiant": true,
            "gainFormatMigrated": true,
            "_id": "string",
            "createdAt": "2024-07-29T15:51:28.071Z",
            "updatedAt": "2024-07-29T15:51:28.071Z"
          },
          "name": "string",
          "isDefault": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "source": "CRM",
        "barcode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "companyName": "string",
        "renewalDate": "2024-07-29T15:51:28.071Z",
        "phoneNumber": "string",
        "birthDate": "2024-07-29T15:51:28.071Z",
        "admissionDate": "2024-07-29T15:51:28.071Z",
        "gain": 0,
        "gainHistory": [
          {
            "gain": 0,
            "date": "2024-07-29T15:51:28.071Z"
          }
        ],
        "communicationPreferences": [
          {
            "notificationType": "NEW_LOYALTY",
            "sms": true,
            "email": true,
            "notification": true
          }
        ],
        "pushInformativeEnabled": true,
        "pushCommercialEnabled": true,
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "transit": {
        "wallet": {
          "name": "string",
          "logo": "string",
          "icon": "string",
          "androidLogo": "string",
          "displayIdentifiant": true,
          "passBuilderPassTemplateId": "string",
          "passBuilderBusinessId": "string",
          "passBuilderToken": "string",
          "identifier": "string",
          "identifierQr": "string",
          "address": "string",
          "website": "string",
          "servicePhone": "string",
          "businessPhone": "string",
          "socialMedia": {
            "linkedin": "string",
            "facebook": "string",
            "instagram": "string",
            "tiktok": "string",
            "twitter": "string",
            "youtube": "string",
            "snapchat": "string",
            "pinterest": "string",
            "reddit": "string",
            "whatsapp": "string",
            "telegram": "string"
          },
          "additionalContacts": [
            {
              "title": "string",
              "value": "string",
              "kind": "URL"
            }
          ],
          "termsAndConditions": {
            "type": "PDF",
            "customUrl": "string",
            "pdfUrl": "string"
          },
          "webHookUrl": "string",
          "rootDomain": "string",
          "timezone": "string",
          "allowedPasses": [
            "ALL"
          ],
          "expiredCleanupEnabled": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "barcodeFormat": "AZTEC",
        "terms": "string",
        "emailSubscriptionMessage": "string",
        "subscriptionMessage": "string",
        "locations": [
          {
            "longitude": 0,
            "latitude": 0,
            "relevantName": "string",
            "relevantAddress": "string"
          }
        ],
        "colors": {
          "labelColor": "string",
          "backgroundColor": "string",
          "foregroundColor": "string"
        },
        "strip": "string",
        "customerServiceNumber": "string",
        "originStationCode": "string",
        "originName": "string",
        "destinationStationCode": "string",
        "destinationName": "string",
        "departureTime": "string",
        "arrivalTime": "string",
        "tarif": "string",
        "details": "string",
        "number": "string",
        "type": "Bus",
        "gateName": "N_CABINE",
        "seatName": "N_CABINE",
        "security": {
          "enableOneTimeUse": true,
          "disableIOSPassSharing": true,
          "disablePassLinkSharing": true,
          "disableMultipleHolders": true,
          "enableSecurityAnimation": true,
          "enableRotatingBarcode": true
        },
        "passBuilderPassTemplateId": "string",
        "customBackFields": [
          "string"
        ],
        "displayOptions": {
          "hideTarif": true,
          "hideStationCodes": true,
          "hideTripNumber": true
        },
        "iosHeader": {
          "labelEnum": "FULLNAME",
          "valueEnum": "FULLNAME",
          "customLabel": "string",
          "customValue": "string"
        },
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "event": {
        "status": "PENDING",
        "wallet": {
          "name": "string",
          "logo": "string",
          "icon": "string",
          "androidLogo": "string",
          "displayIdentifiant": true,
          "passBuilderPassTemplateId": "string",
          "passBuilderBusinessId": "string",
          "passBuilderToken": "string",
          "identifier": "string",
          "identifierQr": "string",
          "address": "string",
          "website": "string",
          "servicePhone": "string",
          "businessPhone": "string",
          "socialMedia": {
            "linkedin": "string",
            "facebook": "string",
            "instagram": "string",
            "tiktok": "string",
            "twitter": "string",
            "youtube": "string",
            "snapchat": "string",
            "pinterest": "string",
            "reddit": "string",
            "whatsapp": "string",
            "telegram": "string"
          },
          "additionalContacts": [
            {
              "title": "string",
              "value": "string",
              "kind": "URL"
            }
          ],
          "termsAndConditions": {
            "type": "PDF",
            "customUrl": "string",
            "pdfUrl": "string"
          },
          "webHookUrl": "string",
          "rootDomain": "string",
          "timezone": "string",
          "allowedPasses": [
            "ALL"
          ],
          "expiredCleanupEnabled": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "barcodeType": "AZTEC",
        "name": "string",
        "locations": [
          {
            "longitude": 0,
            "latitude": 0,
            "address": "string",
            "locationName": "string"
          }
        ],
        "date": {
          "startDate": "2024-07-29T15:51:28.071Z",
          "endDate": "2024-07-29T15:51:28.071Z",
          "doorOpeningHour": "2024-07-29T15:51:28.071Z"
        },
        "price": 0,
        "gainUnit": "NONE",
        "description": "string",
        "terms": "string",
        "subscriptionMessage": "string",
        "emailSubscriptionMessage": "string",
        "contactPhone": "string",
        "email": "string",
        "website": "string",
        "colors": {
          "labelColor": "string",
          "backgroundColor": "string",
          "foregroundColor": "string"
        },
        "security": {
          "enableOneTimeUse": true,
          "disableIOSPassSharing": true,
          "disablePassLinkSharing": true,
          "disableMultipleHolders": true,
          "enableSecurityAnimation": true,
          "enableRotatingBarcode": true
        },
        "passBuilderPassTemplateId": "string",
        "strip": "string",
        "PKTextAlignmentLeft": "CHAIR",
        "PKTextAlignmentCenter": "ROW",
        "PKTextAlignmentRight": "INACTIVE",
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "storeCard": {
        "wallet": {
          "name": "string",
          "logo": "string",
          "icon": "string",
          "androidLogo": "string",
          "displayIdentifiant": true,
          "passBuilderPassTemplateId": "string",
          "passBuilderBusinessId": "string",
          "passBuilderToken": "string",
          "identifier": "string",
          "identifierQr": "string",
          "address": "string",
          "website": "string",
          "servicePhone": "string",
          "businessPhone": "string",
          "socialMedia": {
            "linkedin": "string",
            "facebook": "string",
            "instagram": "string",
            "tiktok": "string",
            "twitter": "string",
            "youtube": "string",
            "snapchat": "string",
            "pinterest": "string",
            "reddit": "string",
            "whatsapp": "string",
            "telegram": "string"
          },
          "additionalContacts": [
            {
              "title": "string",
              "value": "string",
              "kind": "URL"
            }
          ],
          "termsAndConditions": {
            "type": "PDF",
            "customUrl": "string",
            "pdfUrl": "string"
          },
          "webHookUrl": "string",
          "rootDomain": "string",
          "timezone": "string",
          "allowedPasses": [
            "ALL"
          ],
          "expiredCleanupEnabled": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "cardType": "STORE_CARD",
        "displayIdentifiant": true,
        "displayWalletName": true,
        "strip": "string",
        "passBuilderPassTemplateId": "string",
        "programName": "string",
        "keysHasChanged": [
          "string"
        ],
        "startRow": "CREATION_DATE",
        "middleRow": "CREATION_DATE",
        "endRow": "CREATION_DATE",
        "iosHeader": {
          "labelEnum": "TYPE",
          "valueEnum": "TYPE",
          "customLabel": "string",
          "customValue": "string"
        },
        "barcodeType": "AZTEC",
        "descriptions": [
          {
            "title": "string",
            "value": "string"
          }
        ],
        "openingHours": "string",
        "colors": {
          "labelColor": "string",
          "backgroundColor": "string",
          "foregroundColor": "string"
        },
        "oneTimeToUse": true,
        "sharingProhibited": true,
        "sharingProhibitedAndroid": true,
        "validity": {
          "expirationType": "NO_EXPIRATION",
          "expirationDate": "2024-07-29T15:51:28.071Z",
          "expirationAfterPeriod": "string",
          "expirationPeriodType": "YEARS",
          "expirationOption": "AT_CREATION_DATE"
        },
        "gainLabel": "GAIN",
        "gainUnit": "NONE",
        "offerLabel": "string",
        "enableDisplayIdentifiant": true,
        "gainFormatMigrated": true,
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "wallet": {
        "name": "string",
        "logo": "string",
        "icon": "string",
        "androidLogo": "string",
        "displayIdentifiant": true,
        "passBuilderPassTemplateId": "string",
        "passBuilderBusinessId": "string",
        "passBuilderToken": "string",
        "identifier": "string",
        "identifierQr": "string",
        "address": "string",
        "website": "string",
        "servicePhone": "string",
        "businessPhone": "string",
        "socialMedia": {
          "linkedin": "string",
          "facebook": "string",
          "instagram": "string",
          "tiktok": "string",
          "twitter": "string",
          "youtube": "string",
          "snapchat": "string",
          "pinterest": "string",
          "reddit": "string",
          "whatsapp": "string",
          "telegram": "string"
        },
        "additionalContacts": [
          {
            "title": "string",
            "value": "string",
            "kind": "URL"
          }
        ],
        "termsAndConditions": {
          "type": "PDF",
          "customUrl": "string",
          "pdfUrl": "string"
        },
        "webHookUrl": "string",
        "rootDomain": "string",
        "timezone": "string",
        "allowedPasses": [
          "ALL"
        ],
        "expiredCleanupEnabled": true,
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "coupon": {
        "wallet": {
          "name": "string",
          "logo": "string",
          "icon": "string",
          "androidLogo": "string",
          "displayIdentifiant": true,
          "passBuilderPassTemplateId": "string",
          "passBuilderBusinessId": "string",
          "passBuilderToken": "string",
          "identifier": "string",
          "identifierQr": "string",
          "address": "string",
          "website": "string",
          "servicePhone": "string",
          "businessPhone": "string",
          "socialMedia": {
            "linkedin": "string",
            "facebook": "string",
            "instagram": "string",
            "tiktok": "string",
            "twitter": "string",
            "youtube": "string",
            "snapchat": "string",
            "pinterest": "string",
            "reddit": "string",
            "whatsapp": "string",
            "telegram": "string"
          },
          "additionalContacts": [
            {
              "title": "string",
              "value": "string",
              "kind": "URL"
            }
          ],
          "termsAndConditions": {
            "type": "PDF",
            "customUrl": "string",
            "pdfUrl": "string"
          },
          "webHookUrl": "string",
          "rootDomain": "string",
          "timezone": "string",
          "allowedPasses": [
            "ALL"
          ],
          "expiredCleanupEnabled": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "barcodeFormat": "AZTEC",
        "name": "string",
        "description": "string",
        "promoCode": "string",
        "value": "string",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "isMultipleInstance": true,
        "isWelcomeCoupon": true,
        "status": "ACTIVE",
        "source": "INTERNAL",
        "colors": {
          "labelColor": "string",
          "backgroundColor": "string",
          "foregroundColor": "string"
        },
        "strip": "string",
        "emailSubscriptionMessage": "string",
        "subscriptionMessage": "string",
        "security": {
          "oneTimeToUseJwtLink": true,
          "disableIOSPassSharing": true,
          "enableOneTimeUse": true,
          "disableMultipleHolders": true,
          "enableSecurityAnimation": true,
          "enableRotatingBarcode": true
        },
        "valueLabel": "VALUE",
        "iosHeader": {
          "labelEnum": "FULLNAME",
          "valueEnum": "FULLNAME",
          "customLabel": "string",
          "customValue": "string"
        },
        "passBuilderPassTemplateId": "string",
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "passBuilderPassId": "string",
      "passBuilderUpdatedAt": "2024-07-29T15:51:28.071Z",
      "shortId": "string",
      "legacyShortId": "string",
      "kind": "hotel",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "barcode": "string",
      "phoneNumber": "string",
      "devices": [
        {
          "deviceLibraryIdentifier": "string",
          "deviceType": "ANDROID",
          "registeredAt": "2024-07-29T15:51:28.071Z",
          "isDeleted": true
        }
      ],
      "activeIOSDeviceCount": 0,
      "activeAndroidDeviceCount": 0,
      "status": "active",
      "redeemedAt": "2024-07-29T15:51:28.071Z",
      "instanceId": {},
      "instanceLinks": [
        {
          "instanceId": "string",
          "link": "string",
          "name": "string",
          "description": "string"
        }
      ],
      "checkin": "2024-07-29T15:51:28.071Z",
      "checkout": "2024-07-29T15:51:28.071Z",
      "additionalBenefits": [
        "string"
      ],
      "roomNumber": "string",
      "roomCode": "string",
      "gate": "string",
      "seat": "string",
      "originName": "string",
      "destinationName": "string",
      "originStationCode": "string",
      "destinationStationCode": "string",
      "departureTime": "string",
      "arrivalTime": "string",
      "tarif": "string",
      "tripNumber": "string",
      "departureDate": "string",
      "arrivalDate": "string",
      "expirationDate": "2024-07-29T15:51:28.071Z",
      "originalExpirationDate": "2024-07-29T15:51:28.071Z",
      "admissionDate": "2024-07-29T15:51:28.071Z",
      "backFieldName": "string",
      "backFieldContent": "string",
      "customBackFields": [
        "string"
      ],
      "leftRow": "string",
      "centerRow": "string",
      "rightRow": "string",
      "promoCode": "string",
      "value": "string",
      "unit": "string",
      "description": "string",
      "bannerOverrideUrl": "string",
      "downloadedVia": {},
      "shortLink": "string",
      "_id": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }

    API news, once a month

    New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

    Report a technical problem

    An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

    For a fast answer, include:

    • The method and endpoint (e.g. POST /clients)
    • The error code returned (errorCode) and the body sent
    • The date and time of the call
    • The identifiers involved (customer, template, pass)

    Never include an API token or a password.

    AI assistant

    Beta

    Loading…

    AI-generated answers (Claude): double-check important details.

    Sign in to use the assistant