This guide walks through registering a new app on the BringID CredentialRegistry and deploying a custom scorer with personalized credential group scores.
Video walkthrough: See the full UI flow in action — walkthrough.mp4
- A wallet (MetaMask, Coinbase Wallet, etc.) connected to Base (mainnet) or Base Sepolia (testnet)
- Some ETH on the target chain for gas fees
- The App Manager running at https://manager.bringid.org (or
http://localhost:3000for local development)
Navigate to the App Manager. You'll land on the My Apps page, which prompts you to connect your wallet.
Click Connect Wallet in the top-right corner. Select your wallet provider from the modal (MetaMask, Coinbase Wallet, WalletConnect, etc.) and approve the connection.
Make sure your wallet is on the correct network (Base for production, Base Sepolia for testing).
Click Register App in the navigation bar to open the registration form.
The Recovery Timelock determines how long admin recovery actions take. Choose a preset or enter a custom value in seconds:
| Preset | Seconds |
|---|---|
| 1 day | 86,400 |
| 1 week | 604,800 |
| 1 month | 2,592,000 |
| 3 months | 7,776,000 |
| 6 months | 15,552,000 |
| 1 year | 31,536,000 |
| Disabled | 0 |
Select a timelock value. For this example, we choose 1 day (86,400 seconds):
Click Register App. Your wallet will prompt you to confirm the transaction. The button will show:
- "Confirm in wallet..." — waiting for you to approve in your wallet
- "Confirming..." — transaction submitted, waiting for on-chain confirmation
- "Confirmed!" — transaction mined successfully
Once confirmed, a success banner appears showing your new App ID:
App Registered! Your App ID is 3 Save this ID — you'll need it to manage your app.
You'll see two options:
- Go to App Settings — navigate to your app's management page
- Register Another — register an additional app
Click Go to App Settings to continue.
The App Settings page (/apps/{appId}) shows your app's full configuration:
- Status — Active or Suspended, with a toggle button
- Recovery Timelock — current value with an option to update
- Admin Transfer — transfer admin rights to another address (irreversible)
- Scorer Configuration — which scorer your app uses
By default, new apps use the BringID Default Scorer. To customize scoring, you need to deploy and set a custom scorer.
From the Scorer Configuration section, click "Set Custom Scores".
The Deploy Custom Scorer page (/apps/{appId}/scorer/deploy) guides you through a 3-step wizard:
Click Deploy New Scorer. This calls the ScorerFactory.create() contract, deploying a new DefaultScorer instance owned by your wallet.
Confirm the transaction in your wallet. Once mined, the wizard advances to Step 2 and displays your new scorer's contract address.
Tip: If you previously deployed a scorer, it will appear in the "You already have N deployed scorer(s)" section with a Reuse button, letting you skip this step.
The wizard shows: "Scorer deployed at 0x47e5...7bf5"
Click Set App Scorer. This calls CredentialRegistry.setAppScorer(appId, scorerAddress) to wire the new scorer to your app.
Confirm the transaction. Once mined, the wizard advances to Step 3.
A yellow warning banner indicates:
Almost done — set your scores Your custom scorer is deployed but all scores are currently set to 0. You need to set scores before your app can calculate humanity scores.
Click Set Scores to configure your custom scores.
The Manage Scores page (/apps/{appId}/scorer/manage) displays all 15 credential groups in an editable table:
| Column | Description |
|---|---|
| ID | Credential group ID (1-15) |
| Credential | Human-readable name (e.g., Farcaster Low, GitHub High, zkPassport) |
| Status | Whether the credential group is Active |
| Validity | How long a credential proof remains valid (30d, 60d, 90d, 180d) |
| Default Score | The BringID default score for reference |
| Custom Score | Your custom score — editable input field. Header includes Copy defaults and Reset text links. |
| ID | Credential | Default Score | Validity |
|---|---|---|---|
| 1 | Farcaster (Low) | 2 | 30d |
| 2 | Farcaster (Medium) | 5 | 60d |
| 3 | Farcaster (High) | 10 | 90d |
| 4 | GitHub (Low) | 2 | 30d |
| 5 | GitHub (Medium) | 5 | 60d |
| 6 | GitHub (High) | 10 | 90d |
| 7 | X / Twitter (Low) | 2 | 30d |
| 8 | X / Twitter (Medium) | 5 | 60d |
| 9 | X / Twitter (High) | 10 | 90d |
| 10 | zkPassport | 20 | 180d |
| 11 | Self | 20 | 180d |
| 12 | Uber Rides | 10 | 180d |
| 13 | Apple Subs | 10 | 180d |
| 14 | Binance KYC | 20 | 180d |
| 15 | OKX KYC | 20 | 180d |
-
Click Copy defaults in the Custom Score column header to pre-fill all fields with BringID's default scores, or enter your desired scores manually. For example:
- Farcaster (Low):
5 - Farcaster (Medium):
10 - Farcaster (High):
20
- Farcaster (Low):
-
The Save button updates to show how many scores you've changed: "Save 3 Score(s)"
-
Click the Save button. This calls
DefaultScorer.setScores(ids[], scores[])in a single batch transaction. -
Confirm in your wallet. Once mined, you'll see "Transaction confirmed." and the table refreshes with your new scores.
Reset — Click the Reset link in the Custom Score column header to discard all unsaved changes.
After saving scores, click Check Integration at the bottom of the Manage Scores page. This opens the SDK Demo page pre-configured with your app.
The Demo page lets you test:
- verifyHumanity — Start the BringID humanity verification flow (opens a modal)
- verifyProofs — Verify on-chain proofs and see the score breakdown by credential group
The Score Explorer page (/scores) provides a read-only view of all credential groups and their default scores from the BringID DefaultScorer:
Use this as a reference when deciding how to set your custom scores.
| Step | Action | Contract Call |
|---|---|---|
| 1 | Connect wallet | — |
| 2 | Register app with timelock | CredentialRegistry.registerApp(timelock) |
| 3 | View app settings | CredentialRegistry.apps(appId) (read) |
| 4a | Deploy custom scorer | ScorerFactory.create() |
| 4b | Wire scorer to app | CredentialRegistry.setAppScorer(appId, scorer) |
| 5 | Set custom scores | DefaultScorer.setScores(ids[], scores[]) |
| 6 | Test integration | BringID SDK |
| Contract | Address |
|---|---|
| Semaphore | 0x8A1fd199516489B0Fb7153EB5f075cDAC83c693D |
| CredentialRegistry | 0x17a22f130d4e1c4ba5C20a679a5a29F227083A62 |
| Default Scorer | 0x6791B588dAdeb4323bc1C3d987130bC13cBe3625 |
| Scorer Factory | 0x016bC46169533a8d3284c5D8DD590C91783C8C06 |