Membership Card API

Create/Update Membership Card

POST https://api.getlivepass.com/membership-card/<id>

Create or update Membership Card. Email notification will be sent when email is valid and silent=false

Headers

Name	Value
Content-Type	application/json
Authorization	API_KEY <your_api_key>

Body

Name	Type	Description
full_name	string	Full Name of the customer
email	string	Email Address of the customer
phone_number	string	Phone Number (International)
silent	bool	Set to true to NOT send any communication. Set to false to send email or push update.
balance_amount	number	Balance Amount
balance_currency	string	Balance Currency (real or virtual)
membership_tier	string	Membership Tier
barcode_type	enum	Allowed values: qr
barcode_data	string	String to encode with selected barcode_type (Usually equal to id)

Request

curl

curl 'https://api.getlivepass.com/membership-card/VIP-1' \
  -H 'Authorization: API_KEY <your_api_key>' \
  --data-raw '{"full_name":"John Appleseed","email":"[email protected]","phone_number":"[phone]","barcode_type":"qr","barcode_data":"VIP-1","silent":false,"balance_amount":500,"balance_currency":"points","membership_tier":"Gold"}'

Node.js

const axios = require('axios');

const apiKey = '<your_api_key>';
const id = 'VIP-1';
const data = {
  full_name: "John Appleseed",
  email: "[email protected]",
  phone_number: "[phone]",
  barcode_type: "qr",
  barcode_data: "VIP-1",
  silent: false,
  balance_amount: 500,
  balance_currency: "points",
  membership_tier: "Gold"
};

axios.post(`https://api.getlivepass.com/membership-card/${id}`, data, {
  headers: {
    'Authorization': `API_KEY ${apiKey}`,
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error making request:', error);
});

Response

200 - Success

{
    "type": "membership-card",
    "id": "VIP-1",
    "body": {
        "full_name": "John Appleseed",
        "email": "[email protected]",
        "phone_number": "[phone]",
        "barcode_type": "qr",
        "barcode_data": "VIP-1",
        "silent": false,
        "balance_amount": 500,
        "balance_currency": "points",
        "membership_tier": "Gold"
    },
    "message": "Pass requested"
}

400 - Bad Request

{
  "message": {
    "_original": {
      "full_name": "John Appleseed",
      "email": "[email protected]",
      "phone_number": "[phone]",
      "barcode_data": "VIP-1",
      "silent": false,
      "balance_amount": "500",
      "balance_currency": "points",
      "membership_tier": "Gold"
    },
    "details": [
      {
        "message": "\"barcode_type\" is required",
        "path": [
          "barcode_type"
        ],
        "type": "any.required",
        "context": {
          "label": "barcode_type",
          "key": "barcode_type"
        }
      }
    ]
  }
}

403 - Access Denied

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

Use this endpoint to send Membership or update information on existing pass. User will be notified when you change:

• balance_amount

• balance_currency

• membership_tier

---

Get Membership Card

GET https://api.getlivepass.com/membership-card/<id>

Get Membership Card info including links to preview or download.

Headers

Name	Value
Content-Type	application/json
Authorization	API_KEY <your_api_key>

Request

curl

curl 'https://api.getlivepass.com/membership-card/VIP-1' \
  -H 'Authorization: API_KEY <your_api_key>'

Node.js

const axios = require('axios');

const apiKey = '<your_api_key>';
const id = 'VIP-1';

axios.get(`https://api.getlivepass.com/membership-card/${id}`, {
  headers: {
    'Authorization': `API_KEY ${apiKey}`
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error making request:', error);
});

Response

200 - Success

{
  "message": "Pass retrieved",
  "body": {
    "version": 5,
    "created_at": 1723920099,
    "membership_tier": "Gold",
    "barcode_data": "VIP-1",
    "barcode_type": "qr",
    "silent": false,
    "full_name": "John Appleseed",
    "email": "[email protected]",
    "token": "[MASKED]",
    "balance_amount": 500,
    "last_updated_at": 1724001197,
    "phone_number": "[phone]",
    "balance_currency": "points",
    "type": "membership-card"
  },
  "links": {
    "web": "https://getlivepass.com/view/xxxxx",
    "apple": "https://getlivepass.com/apple/xxxxx"
  },
  "id": "VIP-1",
  "type": "membership-card"
}

404 - Not Found

{
  "message": "Pass not found"
}

403 - Access Denied

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

---

Do you have any questions, feedback or ideas? Contact us by email or live chat.