openapi: 3.0.3
info:
  title: Email Validation
  version: 1.0.0
servers:
  - url: https://control.msg91.com
paths:
  /api/v5/email/validate:
    post:
      operationId: email-validation
      summary: Email Validation
      parameters:
        - name: '0'
          in: path
          required: true
          schema:
            type: string
        - name: content-type
          in: header
          required: false
          schema:
            type: string
            example: application/json
        - name: accept
          in: header
          required: false
          schema:
            type: string
            example: application/json
        - name: authkey
          in: header
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
            example:
              email: email-to-be-validated
      responses:
        '200':
          description: Response of success status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      _id:
                        type: string
                      user_id:
                        type: integer
                      count:
                        type: integer
                      is_bulk:
                        type: boolean
                      route:
                        type: integer
                      email:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      charged:
                        type: integer
                      result:
                        type: object
                        properties:
                          valid:
                            type: boolean
                          result:
                            type: string
                          reason:
                            type: string
                          is_disposable:
                            type: boolean
                          is_free:
                            type: boolean
                          is_role:
                            type: boolean
                      summary:
                        type: object
                        properties:
                          total:
                            type: integer
                          deliverable:
                            type: integer
                          undeliverable:
                            type: integer
                          risky:
                            type: integer
                          unknown:
                            type: integer
                  hasError:
                    type: boolean
                  errors:
                    type: object
                    properties: {}
              example:
                status: success
                data:
                  _id: 63677678b5333k8921e070cf7
                  user_id: 5868
                  count: 1
                  is_bulk: false
                  route: 1
                  email: '{{email}}'
                  created_at: '2022-01-01T00:00:00.903000Z'
                  updated_at: '2022-01-01T00:00:03.903000Z'
                  charged: 1
                  result:
                    valid: true
                    result: deliverable
                    reason: ACCEPTED_EMAIL
                    is_disposable: false
                    is_free: false
                    is_role: false
                  summary:
                    total: 1
                    deliverable: 1
                    undeliverable: 0
                    risky: 0
                    unknown: 0
                hasError: false
                errors: {}
        '401':
          description: authkey invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  hasError:
                    type: boolean
                  errors:
                    type: string
                  code:
                    type: string
                  apiError:
                    type: string
              example:
                status: fail
                hasError: true
                errors: Unauthorized
                code: '401'
                apiError: '201'
        '402':
          description: Insufficient Funds
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties: {}
                  hasError:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: string
              example:
                status: fail
                data: {}
                hasError: true
                errors:
                  - You do not have sufficient balance for this operation.
        '422':
          description: Email ID missing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties: {}
                  errors:
                    type: object
                    properties:
                      email:
                        type: array
                        items:
                          type: string
                  message:
                    type: string
                  hasError:
                    type: boolean
                  status:
                    type: string
              example:
                data: {}
                errors:
                  email:
                    - The email field is required.
                message: The given data is invalid
                hasError: true
                status: fail