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

Name	Type	Description
customerIdentifier	string	Customer Identifier

Headers

Name	Type	Description
X-Api-Key	string	API Key

Request Body

Name	Type	Description
object.text	string	Barcode text

200 The Access Pass was successfully updated in imin. The error field includes any errors that occurred for updating the Access Pass in any of the Linked Accounts. If there is no error associated with a given Seller, then the Customer's Access Pass was successfully updated in the Customer's Linked Account within that Seller. If this list is empty, then all Linked Accounts were updated successfully ✅

{
  "@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": { ... }
    }
  ]
]

400

{
  "@context": "https://openactive.io/",
  "@type": "UpdateFailedError",
  "description": "Barcode did not include the expected prefix"
}

Request Example:

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

There is currently no mechanism to delete an Access Pass.