Using the API-KEY

The API key is a required authentication mechanism for all requests to the FortID Issuer and Verifier services. This guide explains how to acquire your API key and how to use it in your API requests.

Introduction

The FortID API key serves as the primary authentication method for accessing the FortID Issuer and Verifier service endpoints. Every request to these services must include a valid API key in the request headers to authenticate and authorize the operation.

How to Acquire an API Key

To get started with FortID services, you need to acquire an API key. You can request your API key by visiting our Issuer pricing page or Verifier pricing page where you can:

• Request a free API key for the Sandbox Tier (ideal for testing and development)
• Request an invoice for the Pro Tier plan (for production use)

Using the API Key with Issuer and Verifier Endpoints

The API key is used with both the FortID Issuer Service and the FortID Verifier Service endpoints. It must be included in the headers of every HTTP request you make to these services.

Header Format

Add the API key to your requests using the X-API-KEY header:

-H "X-API-KEY: <your-api-key-here>"

Example Usage

Here's a simple example showing how to include the API key in a request:

curl -X POST "https://eis.fortid.com/control/issuer" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: <your-api-key-here>" \
  -d '{
    "issuerId": "university-issuer",
    "issuerMetadata": {
      "display": [
        {
          "name": "UniversityIssuer",
          "locale": "en-US",
          "background_color": "#12807c",
          "text_color": "#FFFFFF"
        }
      ]
    }
  }'

More Examples

For detailed examples of using the API key with specific operations, refer to our how-to guides:

• How to Issue a Verifiable Credential - Shows API key usage with Issuer Service endpoints for creating issuers, assigning schemas, and initiating credential issuance
• How to Verify a Verifiable Credential - Shows API key usage with Verifier Service endpoints for initiating verification sessions and checking verification status

These guides contain comprehensive examples showing the API key in context with various API operations.

Summary

In short, using the API key is straightforward: simply add it to the X-API-KEY header of each request you make to the FortID Issuer or Verifier services. The API key authenticates your requests and enables access to the FortID services based on your subscription tier.