Documentation

API
Reference

Everything you need to integrate FingerPay into your application.

🚀

Quick Start

Get started in 5 minutes
🔐

Authentication

JWT & API keys
📡

Endpoints

Full API reference
📦

SDKs

Client libraries
Getting Started

Quick Start Guide

1. Get Your API Key

Sign up for a FingerPay account and generate your API key from the dashboard.

.env
FINGERPAY_API_KEY=fp_live_xxxxxxxxxxxxxx FINGERPAY_API_URL=https://api.fingerpay.ch/v2

2. Install SDK

terminal
# Node.js npm install @fingerpay/sdk # Python pip install fingerpay # Go go get github.com/fingerpay/fingerpay-go

3. Make Your First Call

example.js
const FingerPay = require('@fingerpay/sdk'); const client = new FingerPay({ apiKey: process.env.FINGERPAY_API_KEY }); // Enroll a new user const enrollment = await client.biometric.enroll({ userId: 'user_123', fingerprintTemplate: fingerprintData }); console.log(enrollment); // { success: true, userId: 'user_123', enrolled: true }
Security

Authentication

API Key Authentication

Include your API key in the Authorization header:

request
GET /api/v2/health Authorization: Bearer fp_live_xxxxxxxxxxxxxx Content-Type: application/json

JWT Tokens

After biometric authentication, you receive a JWT token for subsequent requests:

response
{ "success": true, "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expiresIn": 3600, "refreshToken": "rt_xxxxxx" }
Reference

API Endpoints

🔐 Biometric

Method Endpoint Description
POST /biometric/enroll Enroll new user biometric
POST /biometric/authenticate Authenticate via fingerprint
GET /biometric/verify Verify JWT token
PUT /biometric/reenroll Re-enroll biometric template

🏥 Healthcare

Method Endpoint Description
POST /healthcare/lab/access Request LIS/LIMS access
POST /healthcare/patient/verify Verify patient identity
GET /healthcare/stats Get healthcare statistics
DELETE /healthcare/lab/access/:id Revoke lab access

🏦 Banking

Method Endpoint Description
POST /banking/login Passwordless banking login
POST /banking/transaction/authorize Authorize transaction (SCA)
GET /banking/balance Get account balance
POST /banking/transfer Initiate bank transfer

💳 Payments

Method Endpoint Description
POST /payments/initiate Initiate fingerprint payment
POST /payments/methods/link Link payment method
GET /payments/methods Get payment methods
POST /payments/:id/refund Refund payment
Libraries

SDKs & Libraries

Node.js

Official JavaScript/TypeScript SDK for Node.js applications.

npm install @fingerpay/sdk

Python

Official Python SDK for backend applications.

pip install fingerpay

Go

Official Go SDK for high-performance services.

go get github.com/fingerpay/go

iOS (Swift)

Native iOS SDK with Touch ID/Face ID fallback.

pod 'FingerPaySDK'

Android (Kotlin)

Native Android SDK with fingerprint sensor support.

implementation 'ch.fingerpay:sdk'

React Native

Cross-platform mobile SDK for React Native apps.

npm install react-native-fingerpay

Need Help?

Our team is here to help you integrate FingerPay.

Interactive API Docs Contact Support