Developer Documentation

StellarID Docs

Full API reference, OAuth integration guides, ZK circuit docs, Fee Sponsorship, and Multi-Signature — everything you need to build with StellarID.

Quick Start

Get up and running with StellarID in 4 steps. Connect wallet → Get credential → Generate ZK proof → Verify anywhere.

Step 01Connect Your Wallet

Install Freighter wallet extension and connect to StellarID

bash
# 1. Install Freighter from https://www.freighter.app/
# 2. Create or import a Stellar testnet wallet
# 3. Fund it via Stellar Friendbot:
curl https://friendbot.stellar.org?addr=YOUR_WALLET_ADDRESS
Step 02Get Your First Credential

Link GitHub or LinkedIn to receive a verifiable on-chain credential NFT

bash
# GitHub OAuth flow
GET https://stellarid.onrender.com/api/v1/github-issuer/auth?stellarAddress=YOUR_STELLAR_ADDRESS

# LinkedIn OAuth flow  
GET https://stellarid.onrender.com/api/v1/linkedin-issuer/auth?stellarAddress=YOUR_STELLAR_ADDRESS

# Both flows return a JWT token and mint an NFT credential
Step 03Generate a ZK Proof

Generate a zero-knowledge proof to prove a claim without revealing your data

bash
# POST to create a shareable proof
POST https://stellarid.onrender.com/api/v1/proofs
Authorization: Bearer YOUR_JWT_TOKEN
{
  "credentialId": "your-credential-id",
  "circuitType": "age_check",
  "publicInputs": { "threshold": 18 }
}

# Response includes a public share link + PDF download
Step 04Verify a Proof (Platform Integration)

Any platform can verify a StellarID proof using the public endpoint

bash
# Public verification — no auth required
GET https://stellarid.onrender.com/verify/YOUR_PROOF_TOKEN

# Or via API
POST https://stellarid.onrender.com/api/v1/verify
{
  "token": "YOUR_PROOF_TOKEN"
}

Start Integrating

Verify credentials instantly and prove identity statements securely with StellarID.