Skip to content

PERS-api Documentation (2.0.12)

PERS API Documentation

This RESTful API enables seamless integration of Web3 loyalty, token management, and engagement features into your applications.

Usage Guidelines:

  • RESTful Design: Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE) with predictable, resource-oriented URLs.
  • Authentication: Secure access is enforced via Bearer Tokens (JWT) and Project Keys (defining the Tenant context).
  • Data Format: All requests and responses utilize standard JSON formatting.

Explore the modules below for detailed endpoint specifications, schemas, and testing capabilities.

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger
Production API
https://api.pers.ninja/v2
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Security Infrastructure

JSON Web Key Set (JWKS) endpoints for JWT token verification. Provides public keys for secure authentication token validation across the platform ecosystem.
Security Features:

•
JWKS Endpoints:
Standard JSON Web Key Set for JWT verification

•
Public Key Distribution:
Secure distribution of verification keys

•
Token Validation:
Enable third-party JWT token verification

•
Security Standards:
Compliance with OAuth 2.0 and OpenID Connect

•
Cross-Platform Auth:
Support for distributed authentication verification

Request

Security
projectKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/.well-known/jwks.json \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Operations
Operations
Operations
Operations
Operations
Operations