Button Preview
API Reference
v2.0.0Full API documentation is available on GitBook — always up to date with the latest endpoints, parameters, and examples.
Open Full API Docs on GitBook ↗Base URL
https://id.yaphub.xyz
Quick Reference — Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /auth/register | Register a wallet address |
| POST | /auth/challenge | Get a one-time challenge to sign |
| POST | /auth/login | Login → returns access + refresh token |
| POST | /auth/refresh | Refresh access token |
| POST | /auth/logout | Logout current session |
| POST | /auth/logout-all | Logout from all devices |
| POST | /api/verify | Verify a token (public endpoint) |
| GET | /api/userinfo | Get user info (OIDC) |
| GET | /api/status | Service health check |
| GET | /.well-known/openid-configuration | OIDC discovery |
POST /api/verify
The main endpoint for your backend to verify a token:
// Request
POST https://id.yaphub.xyz/api/verify
{ "access_token": "eyJ..." }
// Response
{
"valid": true,
"sub": "uuid",
"accountId": "uuid",
"yapid_premium": false,
"scope": "openid profile",
"expires_in": 3597
}
Live API Tests
GET
/api/status
Check if the YapID service is running.
POST
/api/verify
GET
/.well-known/openid-configuration
OIDC Discovery endpoint.