Get Started

API Key Setup

AeonPass API keys are organization-scoped and issued on request. Follow the steps below to get set up — the whole process takes less than 5 minutes.

Before you begin

API keys are tied to an AeonPass organization. You need an account and an organization in the portal before submitting a request.

  1. 01

    Create a Host account

    Sign up at portal.aeonpass.com and complete your profile. No credit card required to get started.

  2. 02

    Set up your Organization

    From the portal, create an Organization and complete the onboarding steps. The organization is the entity your API key will be scoped to.

  3. 03

    Submit a key request below

    Fill in the request form with your contact details and intended use. We'll verify your account and deliver the API key to your email within 1–2 business days.

Request an API key

Submit your details and we'll provision a key for your organization.

Request your API key

We'll review your request and deliver the key to your email within 1–2 business days.

Fields marked * are required.

What happens next

TimelineWhat we do
ImmediatelyYour request is logged and queued for review.
Within 24hWe verify your organization setup and confirm your account details.
1–2 business daysYour API key is provisioned and emailed to the address you provided.

Using your key

Once you receive your key, add it to your environment variables and pass it in the X-API-KEY header on every request. Never expose the key in client-side code.

# .env.local  — never commit this file
AEONPASS_API_KEY=<your-api-key>
AEONPASS_API_URL=https://apv2-gatewayapp-prod-westus3.azurewebsites.net

# Every request
curl https://apv2-gatewayapp-prod-westus3.azurewebsites.net/api/techaeon/public \
  --request POST \
  --header 'X-API-KEY: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{ "organizationId": "<your-organization-id>" }'

Explore services

With your key in hand, pick a service to start integrating.