Skip to content

Commit e7daeea

Browse files
committed
enable tiktok insta in docs
1 parent a8f0703 commit e7daeea

1 file changed

Lines changed: 116 additions & 8 deletions

File tree

docs.md

Lines changed: 116 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Base Verify is for mini-app builders to allow their users to prove they have ver
1313

1414
**Why This Matters:**
1515

16-
Even if a wallet has few transactions, Base Verify reveals if the user is high-value through their verified X account or Coinbase One subscription.
16+
Even if a wallet has few transactions, Base Verify reveals if the user is high-value through their verified social accounts (X Blue, Instagram, TikTok) or Coinbase One subscription.
1717

1818
This lets you identify quality users regardless of on-chain activity.
1919

@@ -27,7 +27,7 @@ This lets you identify quality users regardless of on-chain activity.
2727

2828
### Provider
2929

30-
An identity platform that Base Verify integrates with. Currently supports **X (Twitter)** and **Coinbase**, with Instagram and TikTok coming soon.
30+
An identity platform that Base Verify integrates with. Currently supports **X (Twitter)**, **Coinbase**, **Instagram**, and **TikTok**.
3131

3232
### Verification
3333

@@ -40,13 +40,17 @@ A specific attribute of the Provider account that can be verified.
4040
**Examples:**
4141

4242
- `verified: true` \- X account has blue checkmark
43-
- `coinbase_one: true` \- Active Coinbase One subscription
43+
- `coinbase_one_active: true` \- Active Coinbase One subscription
4444
- `followers: gt:1000` \- X account has over 1000 followers
45+
- `followers_count: gte:5000` \- Instagram account with 5000+ followers
46+
- `video_count: gte:50` \- TikTok account with 50+ videos
4547

46-
### Token (Sybil Resistance) {#token-(sybil-resistance)}
48+
### Token - Sybil Resistance
4749

4850
A deterministic identifier tied to the Provider account, not the wallet. **This is the key anti-sybil mechanism.**
4951

52+
It is unique per "user" per provider.
53+
5054
**How it works:**
5155

5256
A user verifies their X account with Wallet A:
@@ -267,14 +271,14 @@ See definition of token [above](#token-\(sybil-resistance\)).
267271

268272
When redirecting to Base Verify Mini App:
269273

270-
```
274+
```ts
271275
https://verify.base.dev?redirect_uri={your_app_url}&providers={provider}
272276
```
273277

274278
| Parameter | Required | Description |
275279
| :---- | :---- | :---- |
276280
| `redirect_uri` | Yes | Where to send user after verification |
277-
| `providers` | Yes | Provider to verify: `coinbase` XOR `x` |
281+
| `providers` | Yes | Provider to verify: `coinbase`, `x`, `instagram`, or `tiktok` |
278282

279283
The user completes verification in the mini app, then returns to your `redirect_uri`.
280284

@@ -290,7 +294,8 @@ The user completes verification in the mini app, then returns to your `redirect_
290294

291295
| Trait | Type | Operations | Description | Example Values |
292296
| :---- | :---- | :---- | :---- | :---- |
293-
| `coinbase_one` | Boolean | `eq` | Active Coinbase One subscription | `"true"`, `"false"` |
297+
| `coinbase_one_active` | Boolean | `eq` | Active Coinbase One subscription | `"true"`, `"false"` |
298+
| `coinbase_one_billed` | Boolean | `eq` | User has been billed for Coinbase One | `"true"`, `"false"` |
294299
| `country` | String | `eq`, `in` | User's country code (ISO 3166-1 alpha-2) | `"US"`, `"CA,US,MX"` |
295300

296301
**Examples:**
@@ -299,7 +304,13 @@ The user completes verification in the mini app, then returns to your `redirect_
299304
// Check for Coinbase One subscribers
300305
{
301306
provider: 'coinbase',
302-
traits: { 'coinbase_one': 'true' }
307+
traits: { 'coinbase_one_active': 'true' }
308+
}
309+
310+
// Check for billed Coinbase One subscribers
311+
{
312+
provider: 'coinbase',
313+
traits: { 'coinbase_one_billed': 'true' }
303314
}
304315

305316
// Check for specific country
@@ -364,6 +375,103 @@ The user completes verification in the mini app, then returns to your `redirect_
364375
}
365376
```
366377

378+
### Instagram
379+
380+
**Provider:** `instagram`
381+
382+
**Available Traits:**
383+
384+
| Trait | Type | Operations | Description | Example Values |
385+
| :---- | :---- | :---- | :---- | :---- |
386+
| `username` | String | `eq` | Instagram username | `"john_doe"` |
387+
| `followers_count` | Integer | `eq`, `gt`, `gte`, `lt`, `lte` | Number of followers | `"1000"`, `"50000"` |
388+
| `instagram_id` | String | `eq` | Unique Instagram user ID | `"1234567890"` |
389+
390+
**Examples:**
391+
392+
```ts
393+
// Check for specific username
394+
{
395+
provider: 'instagram',
396+
traits: { 'username': 'john_doe' }
397+
}
398+
399+
// Check for follower count (greater than)
400+
{
401+
provider: 'instagram',
402+
traits: { 'followers_count': 'gt:1000' }
403+
}
404+
405+
// Check for follower count (greater than or equal to)
406+
{
407+
provider: 'instagram',
408+
traits: { 'followers_count': 'gte:5000' }
409+
}
410+
411+
// Combine multiple traits
412+
{
413+
provider: 'instagram',
414+
traits: {
415+
'username': 'john_doe',
416+
'followers_count': 'gte:10000'
417+
}
418+
}
419+
```
420+
421+
### TikTok
422+
423+
**Provider:** `tiktok`
424+
425+
**Available Traits:**
426+
427+
| Trait | Type | Operations | Description | Example Values |
428+
| :---- | :---- | :---- | :---- | :---- |
429+
| `open_id` | String | `eq` | TikTok Open ID (unique per app) | `"abc123..."` |
430+
| `union_id` | String | `eq` | TikTok Union ID (unique across apps) | `"def456..."` |
431+
| `display_name` | String | `eq` | TikTok display name | `"John Doe"` |
432+
| `follower_count` | Integer | `eq`, `gt`, `gte`, `lt`, `lte` | Number of followers | `"1000"`, `"50000"` |
433+
| `following_count` | Integer | `eq`, `gt`, `gte`, `lt`, `lte` | Number of accounts following | `"500"`, `"2000"` |
434+
| `likes_count` | Integer | `eq`, `gt`, `gte`, `lt`, `lte` | Total likes received | `"10000"`, `"100000"` |
435+
| `video_count` | Integer | `eq`, `gt`, `gte`, `lt`, `lte` | Number of videos posted | `"50"`, `"200"` |
436+
437+
**Examples:**
438+
439+
```ts
440+
// Check for follower count
441+
{
442+
provider: 'tiktok',
443+
traits: { 'follower_count': 'gt:1000' }
444+
}
445+
446+
// Check for likes count
447+
{
448+
provider: 'tiktok',
449+
traits: { 'likes_count': 'gte:10000' }
450+
}
451+
452+
// Check for video count
453+
{
454+
provider: 'tiktok',
455+
traits: { 'video_count': 'gte:50' }
456+
}
457+
458+
// Combine multiple traits (e.g., active creator)
459+
{
460+
provider: 'tiktok',
461+
traits: {
462+
'follower_count': 'gte:5000',
463+
'likes_count': 'gte:100000',
464+
'video_count': 'gte:100'
465+
}
466+
}
467+
468+
// Check for specific display name
469+
{
470+
provider: 'tiktok',
471+
traits: { 'display_name': 'John Doe' }
472+
}
473+
```
474+
367475
---
368476

369477
## Try Base Verify

0 commit comments

Comments
 (0)