trustbadge.dev

TRUSTBADGE / DOCUMENTATION

World integration
without guesswork.

Reference material for world owners and developers using the official TrustBadge package.

01

Verification flow

A player starts verification from the in-world panel. The package creates an authenticated request containing the display name, world tag, timestamp, and a one-time nonce. The API resolves the name to a permanent VRChat user ID, reads the account-level 18+ status, stores the limited result, and returns an access state.

  1. Player consentThe panel explains the fields used before a request is sent.
  2. Authenticated lookupThe official package signs an encrypted request that expires quickly.
  3. Permanent matchingThe server associates the result with the VRChat user ID, not a copied display name.
  4. Reusable accessParticipating worlds can recheck the same account after join.
02

World installation

The package and product key are issued through a private Discord ticket. Do not publish or share the key.
  1. Request accessJoin the official Discord and open a world-owner ticket.
  2. Import the packageUse the supported Unity and VRChat SDK versions listed with your package release.
  3. Place the prefabAdd the official TrustBadge prefab and configure restricted trigger zones.
  4. Set the world tagUse a short stable identifier for logs, rate limits, and the optional webhook.
  5. Test every stateVerify success, denial, loading, maintenance, timeout, and recheck behavior before publishing.
03

Expected UI states

Ready

The player can submit an intentional verification request.

Verified

The permanent account ID has an eligible stored result.

Not verified

VRChat did not return an eligible account status.

Maintenance

The global service switch is active. Access controls should fail safely.

Unavailable

The request timed out or the API could not be reached.

Rate limited

The world should wait for the supplied retry interval.

04

Public status API

The status route is unauthenticated and low sensitivity. Worlds poll it for maintenance state and the verified count.

GEThttps://api.trustbadge.dev/api/v1/status
{
  "status": "ok",
  "maintenance": false,
  "verified_count": 1284
}

The website also exposes /api-status. That Cloudflare Pages Function probes the API independently with a four-second timeout, so it can report an outage while the backend is unreachable.

05

World API

The official prefab uses two protected GET routes because VRChat's string downloader supports GET requests. Integrators should not construct these envelopes by hand.

GET/api/v1/verify?kid=&n=&d=&m=Intentional player verification
GET/api/v1/check?kid=&n=&d=&m=Join-time account recheck

kid selects the issued product key. n is a one-time nonce. d is the encrypted payload. m authenticates the request. Invalid, expired, replayed, or rate-limited requests are rejected.

06

Security model

  • Client display names are never accepted as durable identity.
  • Each protected request has authenticated data, a timestamp window, and replay protection.
  • Rate limits apply by source and world tag.
  • Product keys stay outside public repositories and world documentation.
  • Administrative mutations require a Discord-authorized session and an additional request header.
  • Maintenance state propagates without a world redeploy.
07

Data boundary

TrustBadge stores the permanent VRChat user ID, current display name, verification status, and check timestamps. Operational logs can include event type, world tag, result, and limited technical detail. TrustBadge does not receive identity documents, date of birth, legal name, password, or VRChat email address.

Read the complete privacy policy →
08

Support and data requests

Join the official Discord and open a private ticket for package access, integration help, incident reports, account appeals, or record removal. Do not post account IDs, keys, webhook URLs, or private details in public channels.

Open TrustBadge Discord →