Bewary Account API

openapi: 3.2.0
info:
  title: Bewary Account API
  description: 'Scam intelligence for apps and AI agents: links, domains, IPs, phone numbers, SMS short codes, emails, wallets, bank accounts (IBAN), mobile apps and payment handles, each with a typed verdict, facts and reason codes. Contract: https://bewary.app/docs. Pricing: https://bewary.app/pricing.'
  version: 1.9.0
servers:
- url: https://api.bewary.app
security:
- bearer: []
- apiKey: []
- {}
tags:
- name: Account
paths:
  /v1/account:
    get:
      tags:
      - Account
      summary: Credits and recent usage
      description: Works with an API key or a signed-in session.
      operationId: getAccount
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Credits this month and the last calls.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '401':
          description: 'unauthorized: missing, revoked or wrong key, or an option that needs a key'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: 'degraded_unavailable: a needed source is down; retry later'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AccountResponse:
      properties:
        credits:
          $ref: '#/components/schemas/CreditState'
        recent:
          items:
            $ref: '#/components/schemas/UsageRow'
          type: array
          title: Recent
      type: object
      required:
      - credits
      - recent
      title: AccountResponse
    CreditState:
      properties:
        period:
          type: string
          title: Period
          description: The current UTC month, YYYY-MM.
        monthly_free:
          type: integer
          title: Monthly Free
          description: Free credits every key gets each UTC month; they reset.
        monthly_used:
          type: integer
          title: Monthly Used
          description: Free credits used this month.
        prepaid:
          type: integer
          title: Prepaid
          description: Prepaid credits from packs. They never expire and are spent after the free ones.
        remaining:
          type: integer
          title: Remaining
          description: 'What can be spent now: free credits left this month plus prepaid.'
        billing_account:
          type: boolean
          title: Billing Account
          description: 'The account has bought a pack: its receipts and invoices are in the billing portal (POST /v1/billing/portal).'
          default: false
      type: object
      required:
      - period
      - monthly_free
      - monthly_used
      - prepaid
      - remaining
      title: CreditState
    UsageRow:
      properties:
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Request Id
        endpoint:
          type: string
          title: Endpoint
        credits:
          type: integer
          title: Credits
        status:
          anyOf:
          - type: integer
          - type: string
          title: Status
        at:
          anyOf:
          - type: string
          - type: 'null'
          title: At
      type: object
      required:
      - endpoint
      - credits
      - status
      title: UsageRow
    ErrorDetail:
      properties:
        code:
          type: string
          enum:
          - invalid_input
          - unsupported_type
          - unauthorized
          - forbidden
          - quota_exceeded
          - rate_limited
          - not_found
          - input_too_large
          - internal
          - degraded_unavailable
          - gone
          title: Code
        message:
          type: string
          title: Message
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Request Id
      type: object
      required:
      - code
      - message
      title: ErrorDetail
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
      - error
      title: ErrorResponse
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key, bw_…
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key