Access Pass

Manage a Customer's Access Pass

If a Customer has multiple Linked Accounts, they can use your Broker to set a single Access Pass (barcode) to use across them all.

All requests that require the X-Api-Key header must be made Server-side. Otherwise, it would be possible to view the secret API key with a browser.

Set Access Pass

POST https://book.imin.co/api/v2/customer-accounts/:customerIdentifier/actions

Update the Access Pass stored in imin and the Customer's Linked Accounts.

Path Parameters

NameTypeDescription

customerIdentifier

string

Customer Identifier

Headers

NameTypeDescription

X-Api-Key

string

API Key

Request Body

NameTypeDescription

object.text

string

Barcode text

{
  "@context": "https://openactive.io/",
  "@type": "imin:AccessPassUpdateAction",
  "object": {
    "@type": "Barcode",
    "text": "ABC123DEF"
  },
  "error": [
    {
      "@context": "https://openactive.io/",
      "@type": "BarcodeInvalidError",
      "name": "The barcode value specified is not permitted within this booking system.",
      "seller": { ... }
    }
  ]
]

Request Example:

{
  "@context": "https://openactive.io/",
  "@type": "imin:AccessPassUpdateAction",
  "object": {
    "@type": "Barcode",
    "text": "ABC123DEF"
  }  
}

There is currently no mechanism to delete an Access Pass.

Last updated