Authentication

Overview

The 2026-05-01 API authenticates requests via the standard Authorization header with a bearer token. You can view and manage your API keys in the Augustus Dashboard.

Your API key carries many privileges, so keep it secure. Do not share keys in publicly accessible areas such as GitHub or client-side code.

API keys

Set your API key in the Authorization header on every request:

Authorization: Bearer {api_key}

All requests must be made over HTTPS. Requests over plain HTTP or without authentication will fail.

Key format

API keys are prefixed with their environment (e.g. sandbox., prod.) so you can immediately identify which environment a key belongs to. Keys are otherwise opaque. Treat them as a single string.

Environments

Environment	Base URL
Sandbox	`https://api.sandbox.augustus.com`
Production	`https://api.augustus.com`

Sandbox and production are isolated. API keys and resources created in one environment are not accessible in the other.

Key scopes

Each API key carries one or more scopes that gate which resources and actions it can use. See Scopes for the full catalogue, alias semantics, and recommended scope sets for common integration patterns.

Authenticated request

curl https://api.augustus.com/v1/payouts/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer sandbox.ak_test_eXaMpLeKeY..."

import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const payout = await client.payouts.retrieve('a1b2c3d4-e5f6-7890-abcd-ef1234567890')

Errors

Status	Code	When
401	`authentication_required`	Missing or invalid API key
403	`permission_denied`	Valid key but insufficient permissions

⌘I

Getting Started

Resources

Overview

API keys

Key format

Environments

Key scopes

Authenticated request

Errors

​Overview

​API keys

​Key format

​Environments

​Key scopes

​Authenticated request

​Errors

Overview

API keys

Key format

Environments

Key scopes

Authenticated request

Errors