> ## Documentation Index > Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Account > Returns account details. Requires an account-scoped key (`mfx_acct_...`). ## OpenAPI ````yaml /openapi.json get /account openapi: 3.1.0 info: title: mintfax API version: '1.0' description: >- Developer-first fax API. Send faxes with a single API call. ## Authentication Most endpoints require a Bearer token in the `Authorization` header. - **Account keys** (`mfx_acct_...`) access account-level endpoints (`/account`, `/account/balance`, `/account/transactions`, `/account/keys`). - **Environment keys** (`mfx_test_...` for test, `mfx_live_...` for live) access operational endpoints (`/environment`, `/faxes`, `/webhooks`, `/events`). - Registration endpoints (`POST /account/register` and `POST /account/register/verify`) do not require authentication. ## Base URL All API requests use `https://api.mintfax.com/v1` as the base URL. contact: name: mintfax Support email: support@mintfax.com url: https://mintfax.com/docs servers: - url: https://api.mintfax.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: >- Account-level resources: registration, account info, balances, and API keys. - name: Environment description: >- Test and live environment configuration shared across all operational requests. - name: Fax description: Send, list, retrieve, resend, and purge faxes. - name: Events description: >- Read the immutable event log for everything that has happened in the environment. - name: Webhooks description: >- Manage webhook endpoints and inspect or replay individual delivery attempts. paths: /account: get: tags: - Account summary: Get Account description: >- Returns account details. Requires an account-scoped key (`mfx_acct_...`). operationId: getAccount responses: '200': description: '`AccountResource`' content: application/json: schema: $ref: '#/components/schemas/AccountResource' '401': description: The provided API key is not recognised. content: application/json: schema: $ref: '#/components/schemas/Error' examples: api_key_invalid: value: error: api_key_invalid message: The provided API key is not recognised. action: check_credentials docs: https://mintfax.com/docs/errors/api-key-invalid '403': description: >- Live calls require account activation. Complete a first credit purchase to activate. content: application/json: schema: $ref: '#/components/schemas/Error' examples: account_not_activated: value: error: account_not_activated message: >- Live calls require account activation. Complete a first credit purchase to activate. action: activate_account docs: https://mintfax.com/docs/errors/account-not-activated key_not_scoped_for_account: value: error: key_not_scoped_for_account message: >- This API key cannot access account-level endpoints. Use an mfx_acct_ key. action: use_account_key docs: https://mintfax.com/docs/errors/key-not-scoped-for-account '500': description: >- An unexpected error occurred. Please retry; if the problem persists, contact support. content: application/json: schema: $ref: '#/components/schemas/Error' examples: internal_server_error: value: error: internal_server_error message: >- An unexpected error occurred. Please retry; if the problem persists, contact support. action: retry_or_contact_support docs: https://mintfax.com/docs/errors/internal-server-error components: schemas: AccountResource: type: object properties: id: type: string description: Account identifier (acct_-prefixed). examples: - acct_4HGhJ7K2pNm9XqL3VtR8Wz name: type: string description: Account display name. examples: - Acme Corp email: type: string format: email description: Primary account email. examples: - dev@acme.com created_at: type: string format: date-time description: UTC timestamp when the account was created. activated_at: type: - string - 'null' format: date-time description: >- UTC timestamp when the account was activated; null if not yet activated. environment: type: object properties: id: type: string description: Environment identifier (env_-prefixed). examples: - env_2BcD3eF4gH5iJ6kL7mN8oP name: type: string description: Human-readable environment name. type: $ref: '#/components/schemas/EnvironmentType' description: Environment type. examples: - sandbox status: $ref: '#/components/schemas/EnvironmentStatus' description: >- Environment status. Currently always 'active'. Future environment-level suspension would introduce additional values; activation is reported via the account, not here. examples: - active required: - id - name - type - status required: - id - name - email - created_at - activated_at - environment title: AccountResource Error: type: object properties: error: type: string description: Machine-readable error code. example: insufficient_balance message: type: string description: Human-readable description. example: Insufficient balance for this operation. action: type: string description: Suggested next step for the caller. example: top_up_balance docs: type: string format: uri description: URL to the docs entry for this error code. example: https://mintfax.com/docs/errors/insufficient-balance request_id: type: string description: >- Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage. pattern: ^req_[0-9A-HJKMNP-TV-Z]{26}$ example: req_01J9XYZQ8KH7B3R0WXAZP8VW6F context: type: object description: Error-specific extra fields (e.g. balances, validation errors). additionalProperties: [] required: - error - message - action - docs - request_id title: Error EnvironmentType: type: string enum: - sandbox - live title: EnvironmentType EnvironmentStatus: type: string enum: - active title: EnvironmentStatus securitySchemes: bearerAuth: type: http description: |- API key as Bearer token. Use an account key (`mfx_acct_...`) for `/account/*` endpoints, and an environment key (`mfx_test_...` for sandbox, `mfx_live_...` for live) for `/environment/*`, `/faxes`, `/webhooks`, and `/events`. scheme: bearer ````