Get Started

This is developer documentation needed to integrate GetLivePass.com with your business in minutes!

Step 1 — Create API key

You will need API key to make calls to our API.

  1. Login to LivePass

  2. Open API Keys tab

  3. Create new API Key


Step 2 — Make API call

Our API is pretty simple. We have only one endpoint to retrieve or create/update:

GET|POST https://api.getlivepass.com/<type>/<id>

Path VariableTypePossible Values

type

Enum

membership-card, appointment, reservation

id

String

Length from 1 to 100 (Your internal Customer or Pass ID)

POST endpoint used for both - creating and updating passes. When sending pass update, user will be notified (unless you set silent=false)

For JSON Body parameters and examples, reference pages for selected Pass Type:


Step 3 — Go Live (KYC)

Once you ready to go live, we will need to verify your business information (KYC)

  • Login to LivePass

  • Open "Settings" (gear icon) on top of the page

  • Enter Business and Support info

  • Save it

  • Submit for KYC

We will review it quickly and notify you by email once approved! Usually it takes a few minutes.

Last updated