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
- 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.
- Navigate to the API Keys section: After logging in, go to the "API Keys" section.
- Generate an API key: Click on the "+ Create a Key" button to generate a unique API key for your account.
- Store your API key securely: Store your API key in a secure place, as it will be used to access the Passport API.
Getting your Scorer ID
A Scorer is an developer element that can be used to organize different use cases. You need to create a Scorer and associated Scorer ID to be able to request user data via the Passport API. If you are using the Passport API in multiple use cases, you should set up separate Scorers for each one.
For the time being, please make sure you are selecting the Unique Humanity Scorer, and not the Binary Scorer. We will be deprecating these different Scorer types soon.
If you have already selected the Binary Scorer, please disregard the v2 threshold and passing_score fields, as they are currently not correct. We will be updating all Binary Scorers to the new format soon.
- 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.
- Navigate to the Scorer section: After logging in, go to the "Scorer" section
- Create a Scorer: Click on the "+ Create a Scorer" button and input a Scorer name and description. Make sure you use the Unique Humanity scorer, and not the Binary scorer.
- 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}