BounceBan.com - Free Email Verification · GPT-Aktionen

{
  "openapi": "3.0.3",
  "info": {
    "title": "BounceBan",
    "description": "Verify emails",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://api.bounceban.com/v1"
    }
  ],
  "paths": {
    "/verify/single": {
      "get": {
        "description": "Verify email address one by one",
        "operationId": "VerifySingleEmail",
        "parameters": [
          {
            "name": "email",
            "in": "query",
            "description": "The email to verify",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/verify/single/status": {
      "get": {
        "description": "Get the verificcation result for single email verification task using id returned by the /verify/single api. useful if /verify/single doesn't return verification result in a few seconds.",
        "operationId": "GetSingleVerificationStatus",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "id returned by the/verify/single api",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/verify/bulk": {
      "post": {
        "description": "Submit a list of emails for verification. This endpoint returns a task id for querying verification status using /bulk/status and retrieving verification results via /bulk/dump.",
        "operationId": "VerifyBulkEmails",
        "requestBody": {
          "description": "A list of emails to verify",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "emails": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/bulk"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/verify/bulk/status": {
      "get": {
        "description": "Get the latest progress and stats for a bulk email verification task using a task ID",
        "operationId": "GetBulkVerificationStatus",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The task ID of the bulk verification process",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The current status of the bulk verification task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkVerificationStatus"
                }
              }
            }
          }
        }
      }
    },
    "/verify/bulk/dump": {
      "get": {
        "description": "Retrieve verification results for a bulk email verification task using a task ID in JSON format. Results are available within 90 days of verification.",
        "operationId": "GetBulkVerificationDump",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Bulk email verification task ID (returned via the /bulk endpoint)",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EmailVerificationList"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameter"
          },
          "401": {
            "description": "Authorization information is missing or invalid"
          },
          "405": {
            "description": "The account is blocked"
          },
          "429": {
            "description": "Rate limited"
          },
          "500": {
            "description": "Unexpected error"
          }
        }
      }
    },
    "/account": {
      "get": {
        "description": "You can use this API to get account information, including credits balance and rate limits. If you need a higher rate limit, please contact us via the online chat or email us at dev@bounceban.com.",
        "operationId": "GetAccountInformation",
        "responses": {
          "200": {
            "description": "Successful retrieval of account information",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountInformation"
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid"
          },
          "500": {
            "description": "Unexpected error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "VerificationResult": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "valid": {
            "type": "boolean"
          },
          "reason": {
            "type": "string",
            "nullable": true
          }
        }
      },
"bulk": {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier associated with the credit status"
    },
    "credits_remaining": {
      "type": "integer",
      "description": "The number of credits remaining in the user's account"
    }
  }
},
      "BulkVerificationStatus": {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the bulk verification task"
    },
    "status": {
      "type": "string",
      "description": "The status of the bulk verification task"
    },
    "total_count": {
      "type": "integer",
      "description": "The total number of emails processed"
    },
    "deliverable_count": {
      "type": "integer",
      "description": "The count of emails classified as deliverable"
    },
    "undeliverable_count": {
      "type": "integer",
      "description": "The count of emails classified as undeliverable"
    },
    "risky_count": {
      "type": "integer",
      "description": "The count of emails classified as risky"
    },
    "unknown_count": {
      "type": "integer",
      "description": "The count of emails for which the deliverability could not be determined"
    },
    "credits_consumed": {
      "type": "integer",
      "description": "The number of credits consumed by the bulk verification task"
    },
    "credits_remaining": {
      "type": "integer",
      "description": "The number of credits remaining in the user's account after the bulk verification task"
    }
  }
},
"EmailVerificationList": {
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "nullable": true,
      "description": "A cursor for pagination purposes, can be null if there is no further page"
    },
    "items": {
      "type": "array",
      "description": "The list of email verification results",
      "items": {
        "$ref": "#/components/schemas/EmailVerificationResult"
      }
    },
    "result": {
      "type": "string",
      "description": "The result of the API call, indicating overall success or failure"
    }
  }
},
"EmailVerificationResult": {
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the email verification attempt"
    },
    "email": {
      "type": "string",
      "description": "The email address that was verified"
    },
    "result": {
      "type": "string",
      "description": "The result of the email verification, such as 'deliverable'"
    },
    "score": {
      "type": "integer",
      "description": "The score indicating the quality or deliverability of the email address"
    },
    "is_disposable": {
      "type": "boolean",
      "description": "Indicates if the email address is from a disposable email provider"
    },
    "is_accept_all": {
      "type": "boolean",
      "description": "Indicates if the email domain is an 'accept all' domain"
    },
    "is_role": {
      "type": "boolean",
      "description": "Indicates if the email address is a role-based email address"
    },
    "is_free": {
      "type": "boolean",
      "description": "Indicates if the email address is from a free email provider"
    },
    "mx_records": {
      "type": "array",
      "description": "A list of MX records associated with the email domain",
      "items": {
        "type": "string"
      }
    },
    "smtp_provider": {
      "type": "string",
      "description": "The SMTP provider for the email domain"
    },
    "verify_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the email verification was performed"
    }
  }
},
      "AccountInformation": {
        "type": "object",
        "properties": {
          "owner_email": {
            "type": "string",
            "description": "The email address of the account owner"
          },
          "available_credits": {
            "type": "integer",
            "description": "The number of available credits in the account"
          },
          "rate_limit": {
            "type": "array",
            "description": "The rate limits for various API endpoints",
            "items": {
              "type": "object",
              "properties": {
                "api": {
                  "type": "string",
                  "description": "The API endpoint for which the rate limit applies"
                },
                "limit": {
                  "type": "string",
                  "description": "The rate limit for the endpoint, described as a string"
                }
              }
            }
          }
        }
      }
    }
  }
}