Skip to main content

Authentication

Vantage API requests use bearer authentication. You can authenticate with either a short-lived JWT token from the login endpoint or an API key issued for server-to-server integrations.

Two ways to authenticate
  • JWT login — best for interactive testing and password-based accounts. Retrieve a short-lived token via /login.
  • API keys — best for backend integrations and automation. Grab yours from the API page and use it directly, no login required.

JWT Login

Use /login with Basic Auth credentials to retrieve a JWT token:

curl --location -X POST 'https://vantage.open-atlas.com/login' \
--user 'your_username:your_password'

The response contains a bearer token:

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Export the token locally when testing:

export YOUR_BEARER_TOKEN="eyJhbGciOiJIUzI1NiIsInR5cCI6..."

Then include it in the Authorization header:

curl -X GET 'https://vantage.open-atlas.com/users/check_tokens' \
-H "Authorization: Bearer $YOUR_BEARER_TOKEN"

API Keys

API keys are recommended for backend integrations, automation, and accounts that do not use a password-based login flow.

Getting your API key

You can view and copy your API key from the API page in the Vantage app. Log in, navigate to API, and copy the key shown there.

API keys are sent with the same bearer header format:

curl -X GET 'https://vantage.open-atlas.com/users/check_tokens' \
-H "Authorization: Bearer vantage_live_your_api_key"

Token Expiry

JWT tokens are short-lived. If a request returns 401 Unauthorized, authenticate again using /login or switch long-running integrations to API-key authentication.

Integration Tips

  • Keep credentials and API keys in a secret manager or secure environment variables.
  • Use API keys for server-to-server workflows.
  • Use JWT login for interactive testing or password-based integrations.
  • Avoid generating a new JWT for every request.

Need help managing credentials? Contact our team.