Integrate Your Hardware to Verify Members as they Arrive

This step by step tutorial will show you how to verify a membership card and check them in via our API.


Now that you or your vendor are looking to integrate their keycard/ID card solution with our digital and existing ecosystem, there are a few things to keep our environments in sync.  

To preface this article, these are some common use cases this can enable:

  • Member is approaching the space, notify staff they are arriving.
  • Member has lingered around a certain area for too long, send them a message.
  • When you become a member, you immediately gain access.
  • When your membership is no longer active, you immediatley gain access.
  • Add a paywall to physical spaces.


The integration is going to be a two-way integration between Peoplevine and your platform.  The best part is, you have full access to build this directly in Peoplevine without the need to modify your markup to accomodate our data.  In this integration, we're going to first notify your platform when a new member is activated (and/or canceled) so you can update your records to enable/disable access.  This will ensure our databases are in sync.  Then you will need to develop an integration to send us the member data as they check-in.  When doing this, not only will we track visit history on the member's profile, but staff will be immediately notified, systems like Sevenrooms will be notified upon arrival and an infinite amount of automation that you can configure. 

Member is Activated Member is set to Inactive (or cancels) Member Scans in At Door Control We send webhook with data We send webhook With data Sends data to PeopleV ine Member is reg istered in Security System Member is removed from Security System Activity stored in PeopleVine via ve rifyMe mbe hip API call Response includes Send confirm ation extemal ID for To PeopleVlne tracking We need the external ID we received when added along with location.


Get Notified/Data When a New Member is Activated (or Cancelled) to Activate in your System

First we'll get started with setting up the webhooks so you can get new members and member changes to update your system.  Start by going to the Automate suite in Peoplevine and click on Setup New Webhook.  Please note, if you have an expiring token, you will need to setup a new Webhook Auth.

A Webhook Auth enables you to enter the initiation URL, get token URL and refresh URL in an effort for our system to automatically generate that token when it expires.  Please note that your response should have an expires_in field with an integer in minutes.  We will then set this to expire at that time and once expired we will request a new token.

Once you have set this up, you can access the access token by including {@access_token@} in your header or body request.

Now that your Webhook Auth is in place, you will need to setup a webhook to leverage this (and test it out).  Start by clicking on Automate then New Webhook.

When setting up the webhook, you will need to first select the action that will trigger this.  In this case you are going to setup at least 2 triggers.  You want to setup 1) when a member is set to active - so you either register on your side and/or activate if was disabled. 2) when the membership is set to cancelled to disable their access and 3) when the membership changed (to get new membership ID).  You can setup additional as needed (but it's done one at a time).

After you selected which memberships (or all) to process this on, you will then need to setup the webhook to share the data.  Start by adding the URL and then attaching the credentials you created.   Once attached you can then reference the generated token by entering {@access_token@} in the header or body object.

Then select the fields you need in your call.  We currently pull available fields associated with the membersihp.  Some key fields that identify the member back in our system would be customer_no, membership_id and membership_card_no.  Please note the membership_id can change, while the customer_no will never change and the membership_card_no only changes when they have a new membership (not if they membership_id or something else changes). 

Once the webhook is saved (and set to active), any time a member is set to active (or cancelled) we will send you the requested member's data to your API endpoint using your API credentials.  

Once these are in place, any time a new member is activated (or existing switched back to activated), you will get a webhook with their info.  Then once they cancel, you'll be notified to deactivate.  Now that these are in place, lets focus on syncing member check-ins with our platform.


Sync Member Check-Ins with Peoplevine

When a member checks in to your hardware, you can leverage our verifyMembership API to confirm if they are an active member along with logging this data into the member's profile.  To do this, follow these steps:

  • View the verifyMembership API under the Membership Methods
  • Here's a sample object to pass to the API
    {
        "business_location_no"0,
        "membership_card_no"442838,
        "customer_no"2760499,
        "membership_id""",
        "location""Location of Scan",
        "verified_by""device",
        "verified_id": "Device ID",
        "scanner_type""Your System Name"
    }

  • Alternatively, you can pass in the membership_id instead of the customer_no and membership_card_no. 

You will then receive a response that the membership was verified or if it failed for some reason.  This will be returned to you in a response object with isError = true or false and the details in returnObject.

Additional Help Tutorials

Find more ways to grow on PeopleVine.

Splitting Checks and Payments with Micros Simphony and Peoplevine Memberships

Learn how to split checks amongst multiple members and/or guests and allow for multiple different payment types.

Posted October 20, 2021

Stripe V2 Integration Supports Native Tokenization and 3D Secure Payments

With our latest release of our Stripe integration, we are introducing our v2 that provides Stripe native tokenization along with support for 3D secure on the first payment capture.

Posted October 19, 2021

Renew Someone's Failed Subscriptions (with add-ons) in One Charge After it Fails

Some of you know the painpoint of renewing someone's subscription that recently failed and they have multiple items on their subscription. This article explains about a new feature that allows you to charge those in one lump sum.

Posted September 23, 2021

Allow Members and Guests to Book Spa Appointments with Book4Time in Our Latest Integration

With our latest integration to Book4Time, we provide real-time availability, crm sync and more to provide the best experience possible for your members and guests.

Posted August 24, 2021

Get an Alert When Members Pay their Invoices

Of course you can monitor your A/R on a daily basis, but that's tedious and sometimes disappointing. With our latest alert, you can get notified when someone pays an invoice.

Posted August 24, 2021

Build a Survey Application and Answer it on Your Site or App

Are you looking to leverage our tools to manage your CRM and applications, but want to build a custom experience for capturing the responses to an application in Peoplevine?

Posted August 20, 2021

Include a Link to Download Their Membership Card

This quick snippet will help you setup a button to click and take them to their membership card to download.

Posted August 18, 2021

Submit a Survey Response from Your Website

Connect your existing website to our platform by submitting the survey response direct to our JSON.

Posted August 17, 2021

We will Automatically Retry Subscriptions that Failed 3 Days Ago and 7 Days Ago

In an effort to ensure you don't lose funds from members who's card failed during their recurring billing, our system will automatically retry the payment 3 day and 7 days after the first fail.

Posted August 13, 2021

Allow People to Pay at /Charge or /NOT with our New Setting

We added a new setting that requires you to enable the out-of-the-box /charge/# (where # is a dollar amount to charge someone e.g. /charge/10.25 for $10.25).

Posted July 31, 2021

Add Your Own SMS Provider (Currently Working with Twilio)

Add your own SMS provider by providing your own Twilio credentials to leverage your account for sending and receiving messages.

Posted July 30, 2021

Use Auth0 Single Sign On Technology with Peoplevine

You can have your members SSO into your member portal by routing them through Auth0.

Posted July 29, 2021

Issue a Set of Perks to All Members - Great for Special and Last Minute Perks

Looking to bring spike your business? Leverage our feature to re-issue one-time perks to all members in two clicks.

Posted July 29, 2021

Using Adyen as Your Payment Gateway

We support an integration with Adyen, a leader in payments in Europe, to process credit cards for all types of transactions including recurring billing, F&B, merch, event tickets and much more. This article will help you get things setup.

Posted July 20, 2021

Updated Affiliate Reporting for More Visibility and Accuracy

We recently updated our Affiliate engine with more detailed and actionable reporting to help you service your affiliates better and pay them sooner.

Posted July 13, 2021

© Peoplevine 2021. Powered by PeopleVine. Terms of use | Privacy & cookies