sMiles API

This sMiles API documentation helps give an overview of all key app and server components.

Smiles Dark Icon

Introduction

Learn about how the sMiles API & SDK work, and interact with a new or existing user-facing app or platform.

The sMiles API has several core components, which can be used individually or combined

  • Bitcoinverse: Reward users for walking to specific locations. NFC check-in functionality. Option to print a special QR code with loyalty rewards on the receipt.
  • Steps: Pay users for walking more and staying in good shape.
  • Shopping: Reward users for shopping at specific merchants, online and offline.
  • Games: Offer mini-games (fortune wheel, chess, and a tap-to-win game) with Bitcoin rewards, and other wins.
  • Surveys: Incentivize users to complete surveys.
  • Friends: Allow peer-to-peer sharing of loyalty rewards.
  • Withdrawals: Enable users to withdraw their rewards on the Lightning Network or the Bitcoin blockchain.
  • Optional Web App: A user-friendly interface for managing and tracking rewards.
  • Monitoring Dashboard: Adjust reward dynamics in real-time.

Custom Server: A dedicated server for your company.
Integration with Existing Apps: Easily plug SMILES modules into your existing applications.

The sMiles API
Increase user engagement and brand loyalty, by creating a zero-barrier environment for Bitcoin loyalty rewards.
API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Verification Methods
Smiles Verified Badge Icon
  • Email: users register with their email addresses on the client side. A verification code is sent to the user's email address, and must be validated in order for the user to be email verified.
  • Captcha: as an additional security layer, a user must solve a captcha, to help exclude bot attacks.
  • Phone number: phone number verifications are integrated through Twilio. Its API is directly integrated into the verification flow. Any country code can be added to verify global phone numbers.
  • KYC: as an optional endpoint, users can also be fully KYC verified, with liveliness detection and ID checks, using Veriff's API.

Intro:
An existing customer base with partially or fully verified users, can be used in the existing sMiles API framework.

Any of the verification components can be activated to enable user rewards. The underlying rewards infrastructure can also use existing databases of users.
_

Additional security measures such as VPN detection, geo-blocking, and other verification measures, may be used, depending on security needs. Based on all verification components, and a user's behavior on the client side, an integrity score is assigned.

All security layers combined, provide a powerful way to ensure user integrity, and prevent harmful actors.

Components

Intro:
The Lightning backend has several different components. The API can be installed on a client's server, or managed on a new sMiles server.

Client and Server Side
Registration
Verification Methods
  • Email: users register with their email addresses on the client side. A verification code is sent to the user's email address, and must be validated in order for the user to be email verified.
  • Captcha: as an additional security layer, a user must solve a captcha, to help exclude bot attacks.
  • Phone number: phone number verifications are integrated through Twilio. Its API is directly integrated into the verification flow. Any country code can be added to verify global phone numbers.
  • KYC: as an optional endpoint, users can also be fully KYC verified, with liveliness detection and ID checks, using Veriff's API.

Any of the verification components can be activated to enable user rewards. The underlying rewards infrastructure can also use existing databases of users.
_

Additional security measures such as VPN detection, geo-blocking, and other verification measures, may be used, depending on security needs. Based on all verification components, and a user's behavior on the client side, an integrity score is assigned.

All security layers combined, provide a powerful way to ensure user integrity, and prevent harmful actors.

sMiles API
User Sign Up
Smiles Api Bitcoinverse Icon
Bitcoinverse
Find Bitcoin rewards at physical locations

With the Bitcoinverse, you can add a loyalty layer to your app which has a map as a key component. Attract users to specific locations, and monitor how often they visited, how many impressions you got, and how many rewards were paid out.

Bitcoinverse is powerful, any business can attract foot traffic to their locations.

NFC Checkins

A sMiles provided NFC tag, enables users to check in at the store, and earn a reward for doing so. This is a bulletproof way to ensure that a customer has been at the exact NFC location.

The NFC tag uses the Ntag 424 DNA format, which enables highly secure and authenticated check-ins.

QR codes on receipts

With the Bitcoinverse, you can add a loyalty layer to your app which has a map as a key component. Attract users to specific locations, and monitor how often they visited, how many impressions you got, and how many rewards were paid out.

Bitcoinverse is powerful, any business can attract foot traffic to their locations.

Locations Manager (Web)

This tool allows administrators to add, edit, and manage many locations within the map UI. Each location can be assigned specific Bitcoin rewards, making each visit a potentially rewarding experience for users.

An admin also has the ability to modify each location with specific rewards. This customization includes the addition of trackable URLs, location images, and other location data.

Monitoring of the performance of each location + the rewards payouts, make it easy to understand how well a location is performing, and where to add or reduce incentives.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Smiles Running Shoes Icon
Steps
Walking Rewards

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Smiles Games Icon
Fun Mini Games

The sMiles API provides access to 3 games. A fortune wheel, chess, and a tap-to-win fort game.

Games

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Smiles Api Survey Icon
Surveys
Surveys with Rewards

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Shopping
Shopping Rewards at Affiliates

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and SDK components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Smiles Api Survey Icon
Withdrawals
Withdrawals on the Lightning Network

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Friends / P2P
Rewards Sharing

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Web App
Web App

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

API and APP components:

Endpoint: /api/bitcoinverse

POST
'/create-reward-location'
Create a new reward location for users to visit.

GET '/get-reward-locations'
Retrieve a list of available reward locations.

POST '/claim-reward'
Allow users to claim rewards after visiting a specific location.

Admin Dashboard
Admin Dashboard

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

Monitoring

Users register with their email addresses on the client. A verification code is sent to the user's email, and must be entered in order for the user to be partially verified.

As the next step, a user must solve a captcha, to exclude bot attacks.

After this step, a user is considered fully verified.

In order to receive any Bitcoin rewards, the captcha flag must be set to active. An additional captcha may be required, if suspicious user activity is detected, e.g. fake data, timed attacks, etc.

2024 © StandApp, Inc.