Building with Passport
Passport API v1
Getting access

Getting Access: Scorer ID and API Key

The Passport API provides programmatic access to a wallet's Passport score. Once you have your API key, you need to include it with each request you make to the API. This allows Passport XYZ to identify your app and verify that you are authorized to access the API.

Getting Your API Key

  1. Log in to the developer portal: Go to developer.passport.xyz (opens in a new tab) and log in to your account by connecting your wallet.
  2. Navigate to the API Keys section: After logging in, go to the "API Keys" section.
  3. Generate an API key: Click on the "+ Create a Key" button to generate a unique API key for your account.
  4. Store your API key securely: Store your API key in a secure place, as it will be used to access the Passport API.

Scorers and Scorer ID

A Scorer is an individual object with a unique ID that is associated with your account. If you are using the Passport API in multiple applications, you can set up separate communities for each one. This allows you to customize the scoring rules for each application and deduplicate any identical Passport VCs that are submitted to the same application.

By using communities, you can manage specific parameter settings and log traffic for your Passport-enabled applications. This can help you ensure that the identity verification functionality is working correctly and meets the needs of your stakeholders.

Getting your Scorer ID

  1. Log in to the Developer Portal: Go to developer.passport.xyz (opens in a new tab) and log in to your account by connecting your wallet.
  2. Navigate to the Communities section: After logging in, go to the "Communities" section
  3. Create a Scorer: Click on the "+ Create a Scorer" button and input a Scorer name and description.
  4. Find your Scorer ID: Click on the newly created Scorer and you will see the Scorer ID in the page URL.
    Example: https://developer.passport.xyz/dashboard/scorer/{scorer_id}

Types of Scorers

When you create your Scorer you will be presented with several options for the Scorer type. This is because Passport Stamps can be weighted in different ways depending upon the intended use case. Sybil Prevention is the most commonly used.

There are two options currently active for the Sybil prevention model to run in the Scorer.

  • Unique Humanity - Returns a score between 0-100 that indicates how likely it is that a Passport is owned by an honest user
  • Unique Humanity (binary) - Returns a 0 or 1 depending on whether the Passport is flagged as a likely Sybil. Currently, the threshold for a passing score is set to 20.

Selecting the Scorer type

Next step

Review one of the following pages to learn how you can use your Scorer, Scorer ID, and API key.

OverviewQuick start