DMARC Examiner Tools API

openapi: 3.2.0
info:
  title: Dmarc Examiner Com Tools API
  version: 1.0.0
  contact:
    email: support@dmarc-examiner.com
    url: https://dmarc-examiner.com
  license:
    name: Proprietary
  description: 'Operations tagged Tools across 2 of this provider''s published API definitions: dmarc-examiner-com-openapi.yaml, openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dmarc-examiner.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Tools
  description: Free DMARC utilities
paths:
  /api/v1/check-dmarc:
    post:
      operationId: checkDmarc
      summary: Inspect existing DMARC record
      description: 'Free utility — looks up the DMARC record at `_dmarc.{domain}` for any

        domain. Useful for due diligence before onboarding a new domain.

        The domain does not need to belong to the organization.'
      tags:
      - Tools
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckDmarcRequest'
      responses:
        '200':
          description: DMARC inspection result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DmarcCheckResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
components:
  responses:
    Unauthorized:
      description: 'Authentication failed. Two shapes are possible depending on cause:

        - **Invalid or revoked key** — body is `{"message": "..."}` only.

        - **Missing `X-API-Key` header** — body adds an `error: "unauthorized"` machine-readable code.

        Clients should treat both as the same outcome and read `message` for display.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              error:
                type: string
                description: Present only when the request had no `X-API-Key` header at all.
                enum:
                - unauthorized
              message:
                type: string
                example: Invalid API key
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
                example: Rate limit exceeded. Maximum 100 requests per minute.
    FeatureNotAvailable:
      description: 'The organization''s current plan does not include the feature required by this endpoint

        (e.g. `apiAccess`, `forensicReports`, `advancedAlerts`). Distinct from `PlanLimitExceeded`

        (HTTP 402), which signals a *quota* exhausted on a feature the plan does include.


        If a customer downgrades to Free, all `/api/v1/*` requests will start returning this response.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            - message
            - feature
            - current_plan
            properties:
              error:
                type: string
                enum:
                - feature_not_available
              message:
                type: string
                example: 'Feature "apiAccess" is not available in your current plan: Free. Please upgrade.'
              feature:
                type: string
                example: apiAccess
              current_plan:
                type: string
                example: free
    BadRequest:
      description: "Request payload, body field, or query parameter is missing, malformed,\noutside documented bounds, or fails type/enum validation.\n\nTwo body shapes can occur:\n- **Body validation errors** (e.g. missing `name`, wrong type) come from\n  the controller and have the form `{\"message\": \"...\"}`.\n- **Query parameter errors** (e.g. `limit` out of range, `auth_failure`\n  off-enum, `domain_id` not a UUID) flow through the API exception\n  subscriber and add an `error: \"bad_request\"` machine-readable code:\n  `{\"error\": \"bad_request\", \"message\": \"Query parameter \\\"limit\\\" must be between 1 and 100, got 999\"}`.\n"
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              error:
                type: string
                description: Present on query-parameter validation errors. Absent on body validation errors.
                enum:
                - bad_request
              message:
                type: string
                example: Domain name is required
  schemas:
    DmarcCheckResult:
      type: object
      required:
      - domain
      - has_existing_dmarc
      - existing_record
      - existing_policy
      - existing_rua
      - existing_ruf
      properties:
        domain:
          type: string
          example: example.com
        has_existing_dmarc:
          type: boolean
        existing_record:
          type:
          - string
          - 'null'
          description: Raw DMARC record string, if present.
          example: v=DMARC1; p=quarantine; rua=mailto:dmarc@example.com
        existing_policy:
          type:
          - string
          - 'null'
          enum:
          - none
          - quarantine
          - reject
          - null
          example: quarantine
        existing_rua:
          type: array
          items:
            type: string
            format: email
          description: Email addresses parsed from the `rua=` tag.
        existing_ruf:
          type: array
          items:
            type: string
            format: email
          description: Email addresses parsed from the `ruf=` tag.
    CheckDmarcRequest:
      type: object
      required:
      - domain
      properties:
        domain:
          type: string
          example: example.com
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key in format `dex_` followed by 32 hex characters. Create keys in Settings > API Keys.
x-refined-from:
- dmarc-examiner-com-openapi.yaml
- openapi.yaml