SendBridge DMARC API

openapi: 3.2.0
info:
  title: Sendbridge DMARC API
  version: 2.0.0
  summary: Email verification and mail testing over a single authenticated API.
  description: 'Sendbridge API v2 is the current public API.


    **Authentication** uses `Authorization: Bearer sbk_live_…` or `sbk_test_…`. Never put the key in the URL.


    **Test keys** (`sbk_test_`) return realistic fixture responses and never charge credits. Start there while you integrate.


    **Live keys** (`sbk_live_`) run the real checks and debit your credit balance.


    Create keys in the app dashboard.


    The previous `/v1/validate` endpoint still works but is frozen. Migrate to `POST /validation/verify`.'
servers:
- url: https://api.sendbridge.com/v2
  description: Production
security:
- bearerAuth: []
tags:
- name: DMARC
  description: Read monitored domains, 7-day DMARC stats, and recent aggregate reports. Live calls are free. Test keys return fixtures.
paths:
  /dmarc/domains:
    get:
      tags:
      - DMARC
      operationId: listDmarcDomains
      summary: List DMARC domains
      responses:
        '200':
          description: Domains for the API key owner.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - meta
                properties:
                  data:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /dmarc/domains/{id}/stats:
    get:
      tags:
      - DMARC
      operationId: getDmarcDomainStats
      summary: 7-day DMARC stats for a domain
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Stats
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - meta
                properties:
                  data:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          $ref: '#/components/responses/NotFound'
  /dmarc/domains/{id}/reports:
    get:
      tags:
      - DMARC
      operationId: listDmarcReports
      summary: Recent aggregate reports for a domain
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Reports
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - meta
                properties:
                  data:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: The API key is missing the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      - meta
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
        meta:
          $ref: '#/components/schemas/Meta'
    ErrorObject:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          enum:
          - invalid_request
          - unauthorized
          - forbidden_scope
          - not_enough_credits
          - not_found
          - unprocessable
          - rate_limited
          - internal_error
        message:
          type: string
        details:
          type: object
          additionalProperties: true
    Meta:
      type: object
      required:
      - request_id
      properties:
        request_id:
          type: string
          examples:
          - req_9f2c11ab22cd33ef44
        mode:
          type: string
          enum:
          - live
          - test
        credits_charged:
          type: number
        credits_remaining:
          type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: API key created in the Sendbridge dashboard. Prefix `sbk_live_` or `sbk_test_`.