api-ninjas-com Validate Email API

openapi: 3.2.0
info:
  title: Ninjas Validate Email API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Validate Email
  description: The Validate Email API allows you to check whether a given email address is valid and return its metadata. This API will check the formatting of the email and the existence of DNS records for the domain to make sure it is a valid email address.
paths:
  /v1/validateemail:
    get:
      tags:
      - Validate Email
      summary: Validate an email address
      description: Checks whether an `email` address is syntactically valid and has a deliverable mail domain. For disposable-address detection use /disposableemail.
      operationId: validateEmail
      security:
      - ApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/ValidateEmailOpenapi_email'
      responses:
        '200':
          description: Successful response with the validation result of the email address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateEmailResponse'
        '400':
          description: Bad Request - Invalid email format or missing email parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateEmailOpenapi_ErrorResponse'
        '401':
          description: Unauthorized - API key is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateEmailOpenapi_ErrorResponse'
        '500':
          description: Internal Server Error - An error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateEmailOpenapi_ErrorResponse'
components:
  schemas:
    ValidateEmailOpenapi_ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Error message describing the failure.
    ValidateEmailResponse:
      type: object
      properties:
        is_valid:
          type: boolean
          description: Whether the email address is valid.
        domain:
          type: string
          description: Domain of the email address.
        email:
          type: string
          description: Email address.
        local_part:
          type: string
          description: The local part of the email address (the portion before the @).
        is_disposable:
          type: boolean
          description: Whether the email address is disposable. We maintain a large database of hundreds of thousands of disposable domains and check against it for every email address.
        is_public:
          type: boolean
          description: Whether the email address comes from a public email domain like Gmail or Yahoo Mail. We match the email domain against our constantly-updated database of millions of known public email providers.
        main_category:
          type: string
          description: 'The main category (L1) of the email role based on its local part (prefix). Possible values include: technical_operations, customer_engagement, automated_transactional, corporate_functions, etc.'
        sub_category:
          type: string
          description: 'The sub-category (L2) of the email role based on its local part (prefix). Possible values include: smtp_mail_administration, general_inquiries, noreply_unmonitored, etc.'
  parameters:
    ValidateEmailOpenapi_email:
      name: email
      in: query
      required: true
      description: Email address to validate.
      schema:
        type: string
        format: email
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api