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
Content-Type
application/json
Authorization
API_KEY <your_api_key>
Body
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 '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":"+971501234567","barcode_type":"qr","barcode_data":"VIP-1","silent":false,"balance_amount":500,"balance_currency":"points","membership_tier":"Gold"}'
Response
{
"type": "membership-card",
"id": "VIP-1",
"body": {
"full_name": "John Appleseed",
"email": "[email protected]",
"phone_number": "+971501234567",
"barcode_type": "qr",
"barcode_data": "VIP-1",
"silent": false,
"balance_amount": 500,
"balance_currency": "points",
"membership_tier": "Gold"
},
"message": "Pass requested"
}
Get Membership Card
GET
https://api.getlivepass.com/membership-card/<id>
Get Membership Card info including links to preview or download.
Headers
Content-Type
application/json
Authorization
API_KEY <your_api_key>
Request
curl 'https://api.getlivepass.com/membership-card/VIP-1' \
-H 'Authorization: API_KEY <your_api_key>'
Response
{
"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": "+971501234567",
"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"
}
Do you have any questions, feedback or ideas? Contact us by email or live chat.
Last updated