Docupilot

Docupilot mfa API

The mfa API from Docupilot — 8 operation(s) for mfa.

GitHub OpenAPI

Operations 8

GET /accounts/mfa/ #
DELETE /accounts/mfa/delete-totp-device/ #
POST /accounts/mfa/disable-mfa/ #
POST /accounts/mfa/enable-mfa/ #
POST /accounts/mfa/generate-backup-tokens/ #
PUT /accounts/mfa/mark-device-primary/ #
GET /accounts/mfa/setup-totp-device/ #
POST /accounts/mfa/verify-totp-device/ Verify Totp device #

Documentation

📖
Documentation
https://help.docupilot.app/developers/api-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/openapi/docupilot-mfa-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/json-schema/

Other Resources

🔗
SwaggerUI
https://{subdomain}.docupilot.app/~/dashboard/api-docs/swagger-ui/
🔗
Webhooks
https://help.docupilot.app/create-document/api-and-webhook-integration
🔗
JSONExamples
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/examples/
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/vocabulary/docupilot-vocabulary.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/json-ld/docupilot.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/docupilot-mfa-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

docupilot-mfa-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Docupilot accounts APIs ai Mfa API
  version: '1.0'
  description: Docupilot accounts APIs
  termsOfService: https://docupilot.app/terms-and-conditions/
  contact:
    name: Team Docupilot
    email: support@docupilot.app
servers:
- url: https://api-us1.docupilot.app
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: mfa
paths:
  /accounts/mfa/:
    get:
      operationId: mfa_list
      parameters:
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      tags:
      - mfa
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '200':
          description: No response body
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/delete-totp-device/:
    delete:
      operationId: mfa_delete_totp_device_destroy
      tags:
      - mfa
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/disable-mfa/:
    post:
      operationId: mfa_disable
      tags:
      - mfa
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MFADisable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MFADisable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MFADisable'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFADisable'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/enable-mfa/:
    post:
      operationId: mfa_enable
      tags:
      - mfa
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '200':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/generate-backup-tokens/:
    post:
      operationId: mfa_generate_backup_tokens_create
      tags:
      - mfa
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '200':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/mark-device-primary/:
    put:
      operationId: mfa_mark_device_primary_update
      tags:
      - mfa
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkDevicePrimary'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MarkDevicePrimary'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MarkDevicePrimary'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkDevicePrimary'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/setup-totp-device/:
    get:
      operationId: mfa_setup_totp_device_retrieve
      tags:
      - mfa
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '200':
          description: No response body
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /accounts/mfa/verify-totp-device/:
    post:
      operationId: mfa_verify_totp_device_create
      summary: Verify Totp device
      tags:
      - mfa
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TotpDeviceVerify'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TotpDeviceVerify'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TotpDeviceVerify'
        required: true
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TOTPDevice'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
components:
  schemas:
    MFADisable:
      type: object
      properties:
        otp:
          type: integer
      required:
      - otp
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
    TOTPDevice:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time when this device was initially created in the system.
        last_used_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The most recent date and time this device was used.
        name:
          type: string
          readOnly: true
          description: The human-readable name of this device.
      required:
      - created_at
      - id
      - last_used_at
      - name
    MarkDevicePrimary:
      type: object
      properties:
        id:
          type: integer
        type:
          enum:
          - email
          - totp
          type: string
      required:
      - id
      - type
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties: {}
        non_field_errors:
          type: array
          items:
            type: string
      required:
      - errors
      - non_field_errors
    ForbiddenError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
    TotpDeviceVerify:
      type: object
      properties:
        t_otp:
          type: integer
      required:
      - t_otp
  securitySchemes:
    OAuthAuthentication:
      type: http
      scheme: bearer
      description: OAuth2 Bearer Token Authentication
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: sessionid
      description: browser based login takes care of this
externalDocs:
  description: Help docs on how to use API
  url: https://help.docupilot.app/developers/api-overview