{
    "openapi": "3.1.0",
    "info": {
        "title": "Email Verifier API",
        "version": "v1",
        "description": "Verify email addresses: syntax, mail server of the domain, disposable and catch-all domains, role addresses and mailbox through connected verification services."
    },
    "servers": [
        {
            "url": "https://api.flowdata.one/v1",
            "description": "FlowData API"
        }
    ],
    "security": [
        {
            "bearerAuth": []
        }
    ],
    "tags": [
        {
            "name": "endpoints",
            "description": "API endpoints"
        }
    ],
    "paths": {
        "/email-verification/{email}": {
            "get": {
                "operationId": "verification",
                "summary": "Verify an email address",
                "description": "Verifies an email address. result is safe (deliverable), risky (deliverable but uncertain), invalid (not deliverable) or unknown (cannot be determined, not billed). reason states why: accepted, catch_all, role_account, disposable, invalid_syntax, invalid_domain, null_mx, rejected, low_quality, unverifiable, processing_objected (the person concerned has objected to the processing of their data) or dns_unavailable. checks contains the individual checks (syntax, mail server, mail provider, disposable domain, role address, catch-all). The existing fields remain: status is valid if mail can be sent to the address, otherwise risky, invalid, disposable or unknown. source shows where the result comes from: DB (stored result), NA (own check) or a verification service (LR, HU, EA). The API answers a syntactically invalid address with HTTP 400.",
                "tags": [
                    "endpoints"
                ],
                "parameters": [
                    {
                        "name": "email",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Email address to verify"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                },
                                "example": {
                                    "email_address": "user@example.com",
                                    "status": "valid",
                                    "source": "NA",
                                    "result": "risky",
                                    "reason": "catch_all",
                                    "checks": {
                                        "syntax": true,
                                        "mx": "ok",
                                        "mail_provider": "other",
                                        "disposable": false,
                                        "role_account": false,
                                        "catch_all": true
                                    }
                                }
                            }
                        }
                    },
                    "default": {
                        "description": "Error response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "description": "FlowData key as Authorization: Bearer fd_…"
            }
        },
        "schemas": {
            "Error": {
                "type": "object",
                "required": [
                    "error"
                ],
                "properties": {
                    "error": {
                        "type": "object",
                        "properties": {
                            "code": {
                                "type": "string"
                            },
                            "message": {
                                "type": "string"
                            },
                            "type": {
                                "type": "string"
                            },
                            "details": {
                                "type": "object"
                            }
                        }
                    }
                }
            }
        }
    }
}