> ## 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.

# Start Registration

> Begins the account registration flow. Sends a 6-digit activation code to the
provided email address. The code is valid for 15 minutes.

Submit the code to `POST /account/register/verify` to complete registration
and receive your API key.

This endpoint does not require authentication.



## OpenAPI

````yaml /openapi.json post /account/register
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/register:
    post:
      tags:
        - Account
      summary: Start Registration
      description: >-
        Begins the account registration flow. Sends a 6-digit activation code to
        the

        provided email address. The code is valid for 15 minutes.


        Submit the code to `POST /account/register/verify` to complete
        registration

        and receive your API key.


        This endpoint does not require authentication.
      operationId: registerAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterViaApiRequest'
      responses:
        '200':
          description: '`RegistrationInitiatedResource`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationInitiatedResource'
        '422':
          description: The request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validation_failed:
                  value:
                    error: validation_failed
                    message: The request failed validation.
                    action: fix_request
                    docs: https://mintfax.com/docs/errors/validation-failed
                    context:
                      errors:
                        to:
                          - The to field is required.
                        file:
                          - The file field is required.
        '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:
    RegisterViaApiRequest:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        email:
          type: string
          format: email
          maxLength: 255
      required:
        - name
        - email
      title: RegisterViaApiRequest
    RegistrationInitiatedResource:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The email address the activation code was sent to.
          examples:
            - dev@acme.com
        message:
          type: string
          description: Human-readable confirmation message.
          examples:
            - Activation code sent. Valid for 15 minutes.
        expires_in:
          type: integer
          description: Seconds until the activation code expires.
          examples:
            - 900
      required:
        - email
        - message
        - expires_in
      title: RegistrationInitiatedResource
    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
  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

````