API Documentation

NATS Installation Guide

3min

This guide goes over how to integrate BlueCheck onto the join page of a NATS install.

Step 1: Creating a BlueCheck Account

In order to integrate BlueCheck with NATS, you will first need to create a BlueCheck API account and create an integration token. You can create an BlueCheck API account using this link or by visitng bluecheck.me.

Once you have registered, you will need to add a payment method before you can create an API token. To do so click on Billing and add a payment method. Once this is complete head to the integration section. Cick the Create button in the top right to generate an API token. Be sure to save the token as you will need it in the following steps.

Step 2: Configuring BlueCheck in the NATS Surfer Configuration

Now that you have a BlueCheck API token, it is time to log in to your NATS admin control panel and navigate to Configuration and then select the Surfer section in the dropdown at the top. Scrolling down - you should see a section titled "Age Verification" where the Age Verification settings can be configured. You can see a screenshot of this section below.

Document image


In order to use BlueCheck you must:

  1. Set the Age_Verification dropdown to BlueCheck.
  2. Add your BlueCheck API token to the BlueCheck_Token field.
  3. Make sure to scroll down to the bottom and click the "Store Changes" button to save your configuration.

The other fields are all optional and depend on your verification preferences / specific use case. Note: if you do not set a global verification method in the BLUECHECK_ALL_SITES_METHOD field, you will need to select a verification method when configuring the specific site in the Step 3.

Step 3: Editing the Site Settings

Navigate to Sites Admin within the NATS admin portal and find the you wish to use BlueCheck on in the site list. Click on the pencil icon to edit the site details.

Document image


You should see BlueCheck selected in the AGE_VERIFICATION field as well as your domain token in the BLUECHECK_TOKEN field. If you did not set a global verification method in Step 2, you will need to make sure to have a BLUECHECK_METHOD in the site details.