{ "openapi": "3.1.0", "info": { "title": "Get Email Address Information API", "description": "This API provides detailed information and validation for a given email address, including domain details, geolocation, and organizational data.\nTo use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\nFor more information about this API, visit the [Interzoid Email Address Validation Demographics API Documentation](https://www.interzoid.com/apis/email-address-validation-demographics).\nYou can also try this API [interactively](https://try.interzoid.com) or in high-speed [batch mode](https://batch.interzoid.com).\n", "version": "1.0.0", "contact": { "name": "Interzoid Support", "url": "https://www.interzoid.com", "email": "support@interzoid.com" } }, "externalDocs": { "description": "API home page and documentation", "url": "https://www.interzoid.com/apis/email-address-validation-demographics" }, "servers": [ { "url": "https://api.interzoid.com", "description": "Production server" } ], "tags": [ { "name": "Email Address Information", "description": "Provides validation and detailed demographics for email addresses." } ], "paths": { "/getemailinfo": { "get": { "operationId": "getEmailInfo", "tags": [ "Email Address Information" ], "summary": "Retrieve Email Address Information", "description": "Returns validation and detailed information for a given email address, such as domain, organization, geolocation, and more. Include your API key (license) in the request. Register for an API key at https://www.interzoid.com/register-api-account.\n", "parameters": [ { "name": "license", "in": "query", "required": true, "description": "Your API license key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\n", "schema": { "type": "string" }, "examples": { "license": { "summary": "API Key Example", "value": "dh8dj2f*****" } } }, { "name": "email", "in": "query", "required": true, "description": "The email address to retrieve information for.", "schema": { "type": "string" }, "examples": { "email": { "summary": "Email Address Example", "value": "joesmith@amazon.com" } } } ], "responses": { "200": { "description": "Successful response containing email address information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Email": { "type": "string", "description": "The email address queried." }, "Response": { "type": "string", "description": "Validation status of the email address." }, "Info": { "type": "string", "description": "Additional validation information." }, "Domain": { "type": "string", "description": "The domain of the email address." }, "IsGovernment": { "type": "string", "description": "Indicates if the domain is governmental." }, "IsEducational": { "type": "string", "description": "Indicates if the domain is educational." }, "IsOrganizational": { "type": "string", "description": "Indicates if the domain is organizational." }, "IsDisposable": { "type": "string", "description": "Indicates if the email is disposable." }, "IsVulgar": { "type": "string", "description": "Indicates if the email contains vulgar content." }, "IsGeneric": { "type": "string", "description": "Indicates if the email is generic." }, "Geolocation": { "type": "string", "description": "Geolocation data for the domain owner." }, "DomainOwner": { "type": "string", "description": "The entity owning the domain." }, "XHandle": { "type": "string", "description": "Associated social media handle (e.g., X/Twitter)." }, "Organization": { "type": "string", "description": "The organization associated with the domain." }, "Revenue": { "type": "string", "description": "Annual revenue of the organization." }, "Employees": { "type": "string", "description": "Number of employees in the organization." }, "HeadquartersCountry": { "type": "string", "description": "Country of the organization's headquarters." }, "HeadquartersCity": { "type": "string", "description": "City of the organization's headquarters." }, "Currency": { "type": "string", "description": "Currency used by the organization." }, "Rate": { "type": "string", "description": "Currency exchange rate." }, "Description": { "type": "string", "description": "Description of the organization." }, "Code": { "type": "string", "description": "Response code, \"Success\" if the call is successful." }, "Credits": { "type": "integer", "description": "Remaining credits for your API license." } } }, "examples": { "success": { "value": { "Email": "joesmith@amazon.com", "Response": "valid", "Info": "mail server ok", "Domain": "amazon.com", "IsGovernment": "", "IsEducational": "", "IsOrganizational": "", "IsDisposable": "", "IsVulgar": "", "IsGeneric": "", "Geolocation": "", "DomainOwner": "Amazon.com, Inc.", "XHandle": "@amazon", "Organization": "Amazon.com, Inc.", "Revenue": "469.8 billion USD (2021)", "Employees": "1540000", "HeadquartersCountry": "United States", "HeadquartersCity": "Seattle, Washington", "Currency": "USD", "Rate": "1.000", "Description": "Amazon is a global e-commerce and cloud computing company, known for its online retail platform, Amazon Web Services, and various consumer electronics like the Kindle and Echo.", "Code": "Success", "Credits": 206513 } } } } } }, "400": { "description": "Bad request (e.g., missing or invalid parameters).", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Invalid license key or email address missing." } } } } }, "402": { "description": "API key not found.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "API key not found." } } } } }, "403": { "description": "Insufficient API credits remaining.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Insufficient API credits remaining." } } } } }, "405": { "description": "Method not allowed.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Method not allowed." } } } } }, "429": { "description": "Rate limits reached.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Rate limits reached." } } } } }, "500": { "description": "Internal server error.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Internal server error." } } } } } } } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "name": "license", "in": "query" } }, "schemas": {} }, "security": [ { "apiKeyAuth": [] } ] }