> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openformat.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Badge Access Verifier

> Verify on-chain whether a given web3 account holds a specific badge. It's ideal for both online and offline access control.

## Use cases

1. **Event Access Control**: Verifying if attendees hold a specific badge in their web3 accounts to grant access to exclusive events, both online (webinars, virtual conferences) and offline (concerts, conventions).
2. **Membership Verification**: Managing access to membership-based services by verifying on-chain badges, allowing seamless and secure authentication for premium content on websites or entry to members-only clubs.
3. **In-Game Permissions**: Unlocking special in-game features, levels, or items by verifying if players hold certain badges, enhancing the gaming experience with integrated blockchain verification.

## Video Setup

<iframe width="100%" height="500" src="https://www.loom.com/embed/bd1f222e98b24550a115768764c853f0?sid=b9cdb962-6c65-4fec-b2d8-7fac1f067776" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen />

## Prerequisites

1. **Setup OPENFORMAT**

   Before you can continue, please complete the following steps to obtain the necessary credentials:

   1. **Go to the [OPENFORMAT Dashboard](https://app.openformat.tech)**
   2. **Register** for an account
   3. **Generate an API Key**
   4. **Create a dApp**
   5. **Create a Badge** (only if required)

2. **User's web3 Account Address**

   Obtain the web3 account address of the user whose badge you want to verify, e.g., `0xeed12ae3b7cc78ea09ba4cc6e34a997b969ea8e6`.

## Get Started

<Steps>
  <Step title="Remix this template">
    [Clone](https://buildship.app/remix?template=openformat-badge-access-verifier)
    this template in BuildShip.
  </Step>

  <Step title="OPENFORMAT Node Inputs">
    Add your OPENFORMAT `API Key` and `dApp ID` into
    the Get User Profile node inputs.
  </Step>

  <Step title="Test Integration">
    To test the integration, click on **Test** and add the `user`
    of your user and the `badgeName` you want to check into the query of the request.

    <video autoPlay muted loop playsInline className="w-full aspect-video" src="https://mintcdn.com/openformat/vGurOUJG2onkcsD3/images/badge-access-verifier/badge-access-verifier-test.mp4?fit=max&auto=format&n=vGurOUJG2onkcsD3&q=85&s=2de3fe34208c0f234a4ac3b8fd325e8b" data-path="images/badge-access-verifier/badge-access-verifier-test.mp4" />
  </Step>
</Steps>

## Node Inputs

### Get User Profile

| Key       | Description                                                               |
| --------- | ------------------------------------------------------------------------- |
| `API Key` | Your OPENFORMAT [API Key](https://app.openformat.tech/home/settings).     |
| `dApp ID` | The ID for your OPENFORMAT [dApp](https://app.openformat.tech/home/apps). |