Augustus API Key API

The API Key API from Augustus — 1 operation(s) for api key.

Operations 1

GET /v1/api_key Introspect current API key #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/augustus:augustus-api-key-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

augustus-api-key-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Augustus Banking API Key API
  description: Augustus Banking API
  version: 0.1.0
  contact:
    name: Augustus
    url: https://docs.augustus.com
    email: developer@augustus.com
servers:
- url: https://api.augustus.com
  description: Production
- url: https://api.sandbox.augustus.com
  description: Sandbox
security:
- BearerAuth: []
tags:
- name: API Key
paths:
  /v1/api_key:
    get:
      description: Returns the API key resource for the key authenticating this request. Useful for verifying which key is in use and discovering its current authorization context without inferring it from rejected requests.
      operationId: ApiKeyController_introspect
      parameters: []
      responses:
        '200':
          description: The authenticated API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyResourceDto'
      summary: Introspect current API key
      tags:
      - API Key
components:
  schemas:
    ApiKeyResourceDto:
      type: object
      properties:
        type:
          type: string
          description: Resource type discriminator.
          enum:
          - api_key
        id:
          type: string
          description: Unique identifier of the API key.
          example: 550e8400-e29b-41d4-a716-44665544000e
        merchant_id:
          type: string
          description: Identifier of the merchant the key belongs to.
          example: 68e0a1b2c3d4e5f607182940
        scopes:
          type: array
          items:
            type: string
            enum:
            - payouts:read
            - payouts:write
            - deposits:read
            - returns:read
            - returns:write
            - conversions:read
            - conversions:write
            - quotes:read
            - accounts:read
            - accounts:write
            - account_programs:read
            - account_holders:read
            - account_holders:write
            - counterparties:read
            - counterparties:write
            - webhook_subscriptions:read
            - webhook_subscriptions:write
            - events:read
            - webhook_deliveries:read
            - webhook_deliveries:write
            - transactions:read
            - simulations:write
            - payout_tracking_events:read
          description: The effective set of scopes for this key. Stored aliases (e.g. `full_access`, `read_only`) are always expanded to concrete `resource:action` scopes against the current registry before they appear here.
        ip_allow_list:
          type: array
          items:
            type: string
          description: IP addresses or CIDR ranges this key is permitted to authenticate from. An empty array means the key is not IP-restricted.
          example:
          - 203.0.113.0/24
        expires_at:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp at which this key expires. `null` if the key has no expiry.
          example: '2027-01-15T10:30:00Z'
          nullable: true
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp at which this key was created.
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp of the last update to this key (e.g. roll, IP allowlist change, revoke). `null` if the key has not been updated since creation.
          example: '2026-01-15T10:35:00Z'
          nullable: true
        api_version:
          type: string
          description: Effective API version for the request (header value or merchant pin).
          example: '2026-05-01'
      required:
      - type
      - id
      - merchant_id
      - scopes
      - ip_allow_list
      - expires_at
      - created_at
      - updated_at
      - api_version
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Bearer token for authentication with Augustus Banking API
x-provenance:
  method: harvested
  publisher: Augustus
  source: https://api.augustus.com/openapi/2026-05-01.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)