cedros-login-server 0.0.39

Authentication server for cedros-login with email/password, Google OAuth, and Solana wallet sign-in
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
//! Individual skill content generators — compliance and admin skills
//!
//! kyc, compliance, rewards, admin

use super::content::ContentConfig;

/// Skill file content for kyc.md
pub fn generate_skill_kyc_md(config: &ContentConfig) -> String {
    let base = &config.base_path;
    format!(
        r#"---
skill: kyc
name: KYC
version: "{version}"
description: KYC identity verification (Stripe Identity)
apiBase: "{base}"
requiresAuth: true
---

# KYC Skill

Identity verification via Stripe Identity. Users are redirected to a hosted
verification flow; the server receives results via webhook.

## Endpoints

| Method | Path | Auth | Description |
|--------|------|------|-------------|
| POST | {base}/kyc/start | User JWT | Start verification session, returns redirectUrl |
| GET | {base}/kyc/status | User JWT | Get status + enforcement mode |

## Start Verification Session

```
POST {base}/kyc/start
Authorization: Bearer <api-key>
```

Response:
```json
{{
  "sessionId": "uuid",
  "redirectUrl": "https://verify.stripe.com/..."
}}
```

## Get KYC Status

```
GET {base}/kyc/status
Authorization: Bearer <api-key>
```

Response:
```json
{{
  "status": "verified",
  "verifiedAt": "2024-01-01T00:00:00Z",
  "expiresAt": "2025-01-01T00:00:00Z",
  "enforcementMode": "all"
}}
```

Status values: `none` | `pending` | `verified` | `failed` | `canceled`

Enforcement modes: `none` | `optional` | `withdrawals` | `deposits` | `all`

## Workflow

1. Call `GET {base}/kyc/status` — check current status.
2. If status is not `verified`, call `POST {base}/kyc/start`.
3. Redirect the user to `redirectUrl` (Stripe hosted flow).
4. Poll `GET {base}/kyc/status` until status changes from `pending`.

## Error Codes

| Code | Description |
|------|-------------|
| UNAUTHORIZED | Not authenticated |
| NOT_FOUND | KYC service not configured |
"#,
        version = config.version,
        base = base
    )
}

/// Skill file content for compliance.md
pub fn generate_skill_compliance_md(config: &ContentConfig) -> String {
    let base = &config.base_path;
    format!(
        r#"---
skill: compliance
name: Compliance
version: "{version}"
description: Compliance & gating — accreditation, sanctions, and token gating
apiBase: "{base}"
requiresAuth: true
---

# Compliance Skill

Accredited investor verification, sanctions screening, and token gating.
Sanctions and token gating are enforced automatically server-side.

## Accredited Investor Verification

| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | {base}/accreditation/status | User JWT | Get accreditation status |
| POST | {base}/accreditation/submit | User JWT | Submit verification (6 methods) |
| POST | {base}/accreditation/upload | User JWT | Upload supporting document (multipart, max 10 MB) |
| GET | {base}/accreditation/submissions | User JWT | List own submissions |

### Get Accreditation Status

```
GET {base}/accreditation/status
Authorization: Bearer <api-key>
```

Response:
```json
{{
  "status": "approved",
  "verifiedAt": "2024-01-01T00:00:00Z",
  "expiresAt": "2025-01-01T00:00:00Z",
  "enforcementMode": "all"
}}
```

Status values: `none` | `pending` | `approved` | `rejected` | `expired`

### Submit Verification

```
POST {base}/accreditation/submit
Authorization: Bearer <api-key>
Content-Type: application/json

{{
  "method": "income",
  "incomeType": "individual",
  "statedAmountUsd": 250000
}}
```

Verification methods: `income` | `net_worth` | `credential` | `third_party_letter` | `insider` | `investment_threshold`

Response:
```json
{{"submissionId": "uuid"}}
```

### Upload Supporting Document

```
POST {base}/accreditation/upload
Authorization: Bearer <api-key>
Content-Type: multipart/form-data

Fields: submissionId (UUID), documentType (string), file (bytes)
Allowed types: PDF, JPEG, PNG, TIFF
```

## Sanctions Screening

Checked automatically on deposit and withdrawal operations. No user-facing
endpoints. Admins can inspect the cache via the admin skills.

## Token Gating

Rules are configured by admins and evaluated server-side. Use
`GET {base}/features` to check whether token gating is enabled for your app.

## Server-to-Server Compliance Check

```
GET {base}/admin/users/{{user_id}}/compliance
Authorization: Bearer <admin-api-key>
```

Response:
```json
{{
  "kycStatus": "verified",
  "accreditedInvestor": true,
  "accreditedVerifiedAt": "2024-01-01T00:00:00Z",
  "tokenGated": true
}}
```

## Error Codes

| Code | Description |
|------|-------------|
| UNAUTHORIZED | Not authenticated |
| NOT_FOUND | Service not configured |
| VALIDATION_ERROR | Invalid method or missing fields |
"#,
        version = config.version,
        base = base
    )
}

/// Skill file content for rewards.md
pub fn generate_skill_rewards_md(config: &ContentConfig) -> String {
    let base = &config.base_path;
    format!(
        r#"---
skill: rewards
name: Rewards
version: "{version}"
description: Referral rewards and payouts
apiBase: "{base}"
requiresAuth: true
---

# Rewards Skill

Referral program: share your code, earn rewards when referred users sign up.
Rewards are paid as platform credits or direct Solana wallet payouts depending
on admin configuration.

## Endpoints

| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | {base}/referral | User JWT | Get referral code + count + directPayoutEnabled |
| GET | {base}/referral/rewards | User JWT | Get rewards summary |
| GET | {base}/referral/rewards/history | User JWT | Get reward history (paginated) |
| POST | {base}/referral/payout-wallet | User JWT | Set or clear payout wallet address |
| POST | {base}/referral/regenerate | User JWT | Regenerate referral code |
| POST | {base}/referral/set-code | User JWT | Set vanity referral code |

## Get Referral Code

```
GET {base}/referral
Authorization: Bearer <api-key>
```

Response:
```json
{{
  "referralCode": "MYCODE",
  "referralCount": 12,
  "directPayoutEnabled": true
}}
```

## Get Rewards Summary

```
GET {base}/referral/rewards
Authorization: Bearer <api-key>
```

Response:
```json
{{
  "totalEarned": 50000,
  "pendingAmount": 5000,
  "pendingCount": 2,
  "currency": "USDC",
  "rewardType": "direct_payout",
  "payoutWalletAddress": "SolanaWallet...",
  "referralCount": 12
}}
```

Reward types: `credits` | `direct_payout`

## Get Reward History

```
GET {base}/referral/rewards/history?limit=20&offset=0
Authorization: Bearer <api-key>
```

Response:
```json
{{
  "items": [
    {{
      "id": "uuid",
      "triggerType": "signup",
      "amount": 2500,
      "currency": "USDC",
      "status": "completed",
      "txSignature": "base58...",
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:01:00Z"
    }}
  ],
  "total": 12
}}
```

Status values: `pending` | `processing` | `completed` | `failed` | `cancelled` | `credited`

## Set Payout Wallet

```
POST {base}/referral/payout-wallet
Authorization: Bearer <api-key>
Content-Type: application/json

{{"walletAddress": "SolanaBase58PublicKey..."}}
```

Pass `{{"walletAddress": null}}` to clear the wallet.

## Set Vanity Code

```
POST {base}/referral/set-code
Authorization: Bearer <api-key>
Content-Type: application/json

{{"code": "MYCODE"}}
```

Code rules: 4–16 uppercase alphanumeric characters (A-Z, 0-9).

## Error Codes

| Code | Description |
|------|-------------|
| UNAUTHORIZED | Not authenticated |
| NOT_FOUND | Referrals feature not enabled |
| VALIDATION_ERROR | Invalid code format or wallet address |
"#,
        version = config.version,
        base = base
    )
}

/// Skill file content for admin.md
pub fn generate_skill_admin_md(config: &ContentConfig) -> String {
    let base = &config.base_path;
    format!(
        r#"---
skill: admin
name: Admin
version: "{version}"
description: System administration and user management
apiBase: "{base}"
requiresAuth: true
requiresAdmin: true
---

# Admin Skill

Administrative operations requiring elevated permissions.

## User Management

### List Users (Org Admin)

```
GET {base}/orgs/{{org_id}}/members?page=1&limit=20
Authorization: Bearer <api-key>
```

### Update User Role

```
PATCH {base}/orgs/{{org_id}}/members/{{user_id}}
Authorization: Bearer <api-key>
Content-Type: application/json

{{"role": "admin"}}
```

### Remove User

```
DELETE {base}/orgs/{{org_id}}/members/{{user_id}}
Authorization: Bearer <api-key>
```

## Organization Settings

### Get Settings

```
GET {base}/orgs/{{org_id}}/settings
Authorization: Bearer <api-key>
```

### Update Settings

```
PUT {base}/orgs/{{org_id}}/settings
Authorization: Bearer <api-key>
Content-Type: application/json

{{...settings...}}
```

## Audit Logs

### Query Audit Events

```
GET {base}/orgs/{{org_id}}/audit?event_type=login&limit=100
Authorization: Bearer <api-key>
```

## Error Codes

| Code | Description |
|------|-------------|
| FORBIDDEN | Requires admin role |
| CANNOT_DEMOTE_OWNER | Cannot change owner's role |
| LAST_OWNER | Cannot remove last owner |
"#,
        version = config.version,
        base = base
    )
}