|
| 1 | +# Age Verification |
| 2 | + |
| 3 | +Verify a user's age through Portal's browser-based verification service. The flow uses Cashu tokens as cryptographic proof — tokens have no monetary value, they serve as tamper-proof verification tickets. |
| 4 | + |
| 5 | +## How it works |
| 6 | + |
| 7 | +1. Your backend creates a verification session → gets a `session_url` |
| 8 | +2. Redirect the user to the `session_url` in their browser |
| 9 | +3. The user completes identity verification |
| 10 | +4. Portal mints a Cashu verification token and returns it via the event stream |
| 11 | +5. Your backend receives the token — verification complete ✅ |
| 12 | + |
| 13 | +The entire flow is handled by a single SDK call (`createVerificationSession`), which creates the session and automatically starts listening for the token. |
| 14 | + |
| 15 | +## Prerequisites |
| 16 | + |
| 17 | +- A **PortalHub** account at [hub.getportal.cc](https://hub.getportal.cc) — create your verification API key and manage your dashboard from there |
| 18 | +- `[verification] api_key` configured in portal-rest |
| 19 | +- A wallet configured (NWC or Breez) — needed for relay connectivity |
| 20 | + |
| 21 | +## Configuration |
| 22 | + |
| 23 | +1. Sign up / log in at [hub.getportal.cc](https://hub.getportal.cc) |
| 24 | +2. Create a verification API key from the dashboard |
| 25 | +3. Add it to your `config.toml`: |
| 26 | + |
| 27 | +```toml |
| 28 | +[verification] |
| 29 | +api_key = "your-api-key" |
| 30 | +``` |
| 31 | + |
| 32 | +Or via environment variable: |
| 33 | + |
| 34 | +```bash |
| 35 | +PORTAL__VERIFICATION__API_KEY=your-api-key |
| 36 | +``` |
| 37 | + |
| 38 | +## Creating a verification session |
| 39 | + |
| 40 | +<custom-tabs category="sdk"> |
| 41 | + |
| 42 | +<div slot="title">HTTP</div> |
| 43 | +<section> |
| 44 | + |
| 45 | +```bash |
| 46 | +# Create session (relays are optional — defaults to [nostr] config) |
| 47 | +curl -s -X POST $BASE_URL/verification/sessions \ |
| 48 | + -H "Authorization: Bearer $AUTH_TOKEN" \ |
| 49 | + -H "Content-Type: application/json" \ |
| 50 | + -d '{}' |
| 51 | +# → { |
| 52 | +# "session_id": "abc-123", |
| 53 | +# "session_url": "https://verify.getportal.cc/?id=abc-123", |
| 54 | +# "ephemeral_npub": "npub1...", |
| 55 | +# "expires_at": 1234567890, |
| 56 | +# "stream_id": "def-456" |
| 57 | +# } |
| 58 | + |
| 59 | +# Poll for the verification token |
| 60 | +curl -s "$BASE_URL/events/def-456" \ |
| 61 | + -H "Authorization: Bearer $AUTH_TOKEN" |
| 62 | +# → cashu_response event with the token when verification completes |
| 63 | +``` |
| 64 | + |
| 65 | +</section> |
| 66 | + |
| 67 | +<div slot="title">JavaScript</div> |
| 68 | +<section> |
| 69 | + |
| 70 | +```typescript |
| 71 | +import { PortalClient } from 'portal-sdk'; |
| 72 | + |
| 73 | +const client = new PortalClient({ |
| 74 | + baseUrl: 'http://localhost:3000', |
| 75 | + authToken: 'your-token', |
| 76 | +}); |
| 77 | + |
| 78 | +// Single call — creates session + listens for token |
| 79 | +const session = await client.createVerificationSession(); |
| 80 | + |
| 81 | +console.log(`Redirect user to: ${session.session_url}`); |
| 82 | + |
| 83 | +// Wait for the user to complete verification |
| 84 | +const result = await client.poll(session, { |
| 85 | + intervalMs: 1000, |
| 86 | + timeoutMs: 5 * 60 * 1000, |
| 87 | +}); |
| 88 | + |
| 89 | +if (result.status === 'success') { |
| 90 | + console.log('Verified!', result.token); |
| 91 | +} else { |
| 92 | + console.log('Failed:', result); |
| 93 | +} |
| 94 | +``` |
| 95 | + |
| 96 | +</section> |
| 97 | + |
| 98 | +</custom-tabs> |
| 99 | + |
| 100 | +## Custom relays |
| 101 | + |
| 102 | +By default, the session uses the relays from your `[nostr]` config. Override per-request: |
| 103 | + |
| 104 | +<custom-tabs category="sdk"> |
| 105 | + |
| 106 | +<div slot="title">HTTP</div> |
| 107 | +<section> |
| 108 | + |
| 109 | +```bash |
| 110 | +curl -s -X POST $BASE_URL/verification/sessions \ |
| 111 | + -H "Authorization: Bearer $AUTH_TOKEN" \ |
| 112 | + -H "Content-Type: application/json" \ |
| 113 | + -d '{ "relays": ["wss://relay.damus.io"] }' |
| 114 | +``` |
| 115 | + |
| 116 | +</section> |
| 117 | + |
| 118 | +<div slot="title">JavaScript</div> |
| 119 | +<section> |
| 120 | + |
| 121 | +```typescript |
| 122 | +const session = await client.createVerificationSession([ |
| 123 | + 'wss://relay.damus.io', |
| 124 | +]); |
| 125 | +``` |
| 126 | + |
| 127 | +</section> |
| 128 | + |
| 129 | +</custom-tabs> |
| 130 | + |
| 131 | +## Requesting a token from a verified user |
| 132 | + |
| 133 | +If a user already holds a verification token (e.g. verified through the mobile app), you can request it directly: |
| 134 | + |
| 135 | +<custom-tabs category="sdk"> |
| 136 | + |
| 137 | +<div slot="title">HTTP</div> |
| 138 | +<section> |
| 139 | + |
| 140 | +```bash |
| 141 | +curl -s -X POST $BASE_URL/verification/token \ |
| 142 | + -H "Authorization: Bearer $AUTH_TOKEN" \ |
| 143 | + -H "Content-Type: application/json" \ |
| 144 | + -d '{ |
| 145 | + "recipient_key": "USER_PUBKEY_HEX", |
| 146 | + "subkeys": [] |
| 147 | + }' |
| 148 | +# → { "stream_id": "..." } |
| 149 | +# Poll events for cashu_response |
| 150 | +``` |
| 151 | + |
| 152 | +</section> |
| 153 | + |
| 154 | +<div slot="title">JavaScript</div> |
| 155 | +<section> |
| 156 | + |
| 157 | +```typescript |
| 158 | +const op = await client.requestVerificationToken(userPubkeyHex, []); |
| 159 | +const result = await client.poll(op, { intervalMs: 1000, timeoutMs: 60_000 }); |
| 160 | +``` |
| 161 | + |
| 162 | +</section> |
| 163 | + |
| 164 | +</custom-tabs> |
| 165 | + |
| 166 | +## Token lifecycle |
| 167 | + |
| 168 | +- **Web verification** tokens have an amount of 1 (single-use ticket) |
| 169 | +- **Mobile app** tokens have an amount of 500 (reusable across services) |
| 170 | +- Tokens use Portal's mint (`https://mint.getportal.cc`) with unit `multi` |
| 171 | +- Cashu is used purely as a protocol — tokens carry no monetary value |
| 172 | +- To prevent replay attacks, **burn the token** after receiving it (see [Cashu Tokens guide](cashu-tokens.md)) |
| 173 | + |
| 174 | +## Verification statuses |
| 175 | + |
| 176 | +| Status | Description | |
| 177 | +|--------|-------------| |
| 178 | +| `success` | Verification passed. `token` field contains the Cashu token. | |
| 179 | +| `rejected` | Verification failed. `reason` may contain details. | |
| 180 | +| `insufficient_funds` | Mint could not issue the token. | |
| 181 | + |
| 182 | +--- |
| 183 | + |
| 184 | +- [Cashu Tokens](cashu-tokens.md) · [Environment Variables](../getting-started/environment-variables.md) · [API Reference](../sdk/api-reference.md) |
0 commit comments