/API

API Keys

On the API Keys page, you can create and manage API keys for use with VerifiedEmail’s API.

The API Keys page

You can create as many or as few API keys as needed. You can customize the access allowed for each by explicitly permitting or blocking the key’s access to each API function.

Creating an API Key

To create an API key, click Create.

Create API keys

In the API Key dialog, enter a name for the API key in the API Key Title field.

The API Key dialog

Next, select or clear the Automatically Refill Credits checkbox.

  • When this checkbox is selected, API actions that would cause your balance to drop below ten available credits will automatically trigger the purchase of sufficient credits to complete the action, using your saved payment method. In the previous illustration, the checkbox is selected.
  • If this checkbox is cleared/not selected–or if your VerifiedEmail account does not have a saved payment method, API actions that would cause your available credit balance to drop below ten will not be completed due to insufficient credits.
  • For more information about purchasing credits and saving a payment method, please see Credits and Packages.

In the Permissions section of the dialog, select the checkbox next to each API function that will be allowed when the request is made using the new API key you are creating.

For example, if you need to create an API key that will be used exclusively to create, list, modify, and disable webhooks, you could clear all checkboxes except the Webhooks checkbox. In the previous illustration, all permissions’ checkboxes are selected/allowed.

Click Save to save the new API key.

Click Save

The new key appears on the API Keys page.

The API Keys page

Copy the value shown in the API Key field of the new card and store it securely. This is the key you will pass when making API requests to VerifiedEmail.

Modifying an API Key

To make changes to an API key, including changing the Automatically Refill Credits setting, changing the key’s permissions, or renaming the key, click the triple dot button at the upper right-hand corner of the card for the key you want to modify.

Modifying an API Key

The API Key dialog appears. Make changes to the settings as needed and click Save.

The API Key dialog

Disabling an API Key

If you disable an API key, VerifiedEmail will no longer accept API requests that include that key for authentication. The API response will indicate that the key is not valid.

Caution: Disabling an API key is permanent and cannot be undone. Existing integrations that rely on the key will no longer function once the key has been disabled.

❗️Use caution when disabling API keys.

To disable an API key, click the triple dot button at the upper right-hand corner of the API key’s card and select Disable.

Disabling an API Key

The Disable <key name>? dialog appears. Click Confirm to confirm that you want to disable the key.

The Disable dialog
8.3.22Version124msRequest Duration7MBMemory Usage
  • infoGrav v1.7.44 - PHP 8.3.22
  • infoEnvironment Name: verified.email
  • infoCache: [false] Setting: [auto] Driver: [file]
  • infoPage cache disabled, rebuilding pages..
  • infoRouted to page /help/api/api-keys (type: doc)
  • debugActive language set to es
  • infoPage cache disabled, rebuilding pages..
  • debugActive language set to en
  • infoPage cache disabled, rebuilding pages..
  • warmingInactive session: session messages may disappear
$_GET
[]
$_POST
[]
$_COOKIE
[]
$_SERVER
array:46 [ "USER" => "www-data" "HOME" => "/var/www" "HTTP_PRIORITY" => "u=0, i" "HTTP_ACCEP...
  • Server (89μs)
  • Loading (553μs)
  • Site Setup (3.19ms)
  • Initialize (2.54ms)
  • Configuration (1.26ms)
  • Pages (41.18ms)
  • Render (56.76ms)
  • Init frontend routes (12.72ms)
  • 1 x Render (45.84%)
    56.76ms
    1 x Pages (33.26%)
    41.18ms
    1 x Init frontend routes (10.27%)
    12.72ms
    1 x Site Setup (2.58%)
    3.19ms
    1 x Initialize (2.05%)
    2.54ms
    1 x Configuration (1.02%)
    1.26ms
    1 x Loading (0.45%)
    553μs
    1 x Server (0.07%)
    89μs
    absolute_urls
    true
    timezone
    default_locale
    null
    param_sep
    :
    wrapped_site
    false
    reverse_proxy_setup
    false
    force_ssl
    false
    force_lowercase_urls
    true
    custom_base_url
    username_regex
    ^[a-z0-9_-]{3,16}$
    pwd_regex
    (?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,}
    intl_enabled
    true
    http_x_forwarded
    array:4 [ "protocol" => true "host" => false "port" => true "ip" => true ]
    languages
    array:14 [ "supported" => array:2 [ 0 => "en" 1 => "es" ] "default_lang" => "en" "in...
    home
    array:2 [ "alias" => "/home" "hide_in_urls" => true ]
    pages
    array:29 [ "type" => "regular" "dirs" => array:1 [ 0 => "page://" ] "theme" => "verified...
    cache
    array:13 [ "enabled" => false "check" => array:1 [ "method" => "file" ] "driver" => "aut...
    twig
    array:9 [ "cache" => true "debug" => false "auto_reload" => true "autoescape" => false "un...
    assets
    array:16 [ "css_pipeline" => true "css_pipeline_include_externals" => true "css_pipeline_befor...
    errors
    array:2 [ "display" => false "log" => true ]
    log
    array:2 [ "handler" => "file" "syslog" => array:2 [ "facility" => "local6" "tag" => "gra...
    images
    array:9 [ "default_image_quality" => 85 "cache_all" => false "cache_perms" => "0755" "debug"...
    media
    array:5 [ "enable_media_timestamp" => false "unsupported_inline_types" => [] "allowed_fallback...
    session
    array:12 [ "enabled" => false "initialize" => true "timeout" => 1800 "name" => "grav-site" ...
    gpm
    array:2 [ "releases" => "stable" "official_gpm_only" => true ]
    http
    array:7 [ "method" => "auto" "enable_proxy" => true "proxy_url" => null "proxy_cert_path" =>...
    accounts
    array:3 [ "type" => "regular" "storage" => "file" "avatar" => "gravatar" ]
    flex
    array:1 [ "cache" => array:3 [ "index" => array:2 [ "enabled" => true "lifetime" =...
    strict_mode
    array:3 [ "yaml_compat" => true "twig_compat" => true "blueprint_compat" => true ]
    debugger
    array:3 [ "enabled" => true "twig" => true "shutdown" => array:1 [ "close_connection" => t...
    include_default_lang_file_extension
    true
    translations_fallback
    false
    anchors
    array:9 [ "enabled" => true "active" => true "selectors" => "#body h2, #body h3, #body h4, #bo...
    breadcrumbs
    array:8 [ "enabled" => true "show_all" => true "built_in_css" => true "include_home" => true...
    email
    array:8 [ "enabled" => true "from" => "elektrowenik@gmail.com" "from_name" => "Client" "to" ...
    error
    array:2 [ "enabled" => true "routes" => array:1 [ 404 => "/error" ] ]
    form
    array:8 [ "enabled" => true "built_in_css" => true "inline_css" => true "refresh_prevention"...
    highlight
    array:1 [ "theme" => "learn" ]
    langfallback
    array:1 [ "enabled" => true ]
    langswitcher
    array:5 [ "enabled" => true "built_in_css" => false "translated_urls" => true "untranslated_...
    markdown-notices
    array:4 [ "enabled" => true "built_in_css" => true "base_classes" => "notices" "level_classe...
    minify-html
    array:4 [ "enabled" => true "mincss" => true "minjs" => true "mode" => "default" ]
    page-inject
    array:4 [ "enabled" => true "active" => true "processed_content" => false "remote_injections...
    problems
    array:2 [ "enabled" => true "built_in_css" => true ]
    simplesearch
    array:14 [ "enabled" => true "built_in_css" => true "built_in_js" => true "display_button" =...
    sitemap
    array:25 [ "enabled" => true "route" => "/sitemap" "ignore_external" => true "ignore_protect...
    user
    array:3 [ "type" => "ReadOnlyStream" "force" => true "prefixes" => array:1 [ "" => array:1...
    cache
    array:3 [ "type" => "Stream" "force" => true "prefixes" => array:2 [ "" => array:1 [ ...
    log
    array:3 [ "type" => "Stream" "force" => true "prefixes" => array:1 [ "" => array:1 [ ...
    tmp
    array:3 [ "type" => "Stream" "force" => true "prefixes" => array:1 [ "" => array:1 [ ...
    backup
    array:3 [ "type" => "Stream" "force" => true "prefixes" => array:1 [ "" => array:1 [ ...
    environment
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:2 [ "" => array:1 [ 0 => "use...
    system
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:1 [ 0 => "sys...
    asset
    array:2 [ "type" => "Stream" "prefixes" => array:1 [ "" => array:1 [ 0 => "assets" ...
    blueprints
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:3 [ 0 => "env...
    config
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:3 [ 0 => "env...
    plugins
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:1 [ 0 => "use...
    plugin
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:1 [ 0 => "use...
    themes
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:1 [ 0 => "use...
    languages
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:3 [ 0 => "env...
    image
    array:2 [ "type" => "Stream" "prefixes" => array:1 [ "" => array:2 [ 0 => "user://imag...
    page
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:1 [ 0 => "use...
    user-data
    array:3 [ "type" => "Stream" "force" => true "prefixes" => array:1 [ "" => array:1 [ ...
    account
    array:2 [ "type" => "ReadOnlyStream" "prefixes" => array:1 [ "" => array:1 [ 0 => "use...
    • infoYour site is using following deprecated features:
    • gravarray:4 [ "message" => "Grav 2.0 will have Twig auto-escaping forced on (can be emulated by turnin...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Boost Email Marketing ROI: Ho...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Bounce Explained: Defin...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Recipient Segmentation:...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Hard Bounce: Meaning And How ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Double Opt-In: Definition, Ho...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Triggered Emails: What They A...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Accept-All Domain: What It Me...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Graymail: Definition, Example...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Personalization: Defini...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Blast: Definition, When...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Real-Time Email Validation: W...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Verification API: Defin...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Opt-Out: What It Means ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Inactive Subscribers: What Th...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Opt-In Email: Types, Benefits...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "KPI In Email Marketing: Defin...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email A/B Testing: Definition...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Permission-Based Email Verifi...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "IP Warming: Meaning And Key S...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Scrubbing: Definition, ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Engagement: What It Is,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Temporary Email Address: What...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Drip Campaigns: Definition, S...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Bounce Rate: Definition and I...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Whitelist: Definition & Its R...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Unsubscribe Rate: Definition,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "DMARC: Definition, How It Wor...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Soft Bounce: Definition, Caus...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Header: Definition, Com...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Notification Emails: Definiti...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Feedback Loop: What It Is and...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Valid Email Address Format: R...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "DKIM: Definition, How It Work...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email List Fatigue: What It I...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Authentication: What It...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Conversion Rate: Definition, ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Footer: Purpose, Key El...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Campaign: Types, Exampl...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Spam Score: Meaning, Risk Fac...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Follow-Up Email Campaigns: De...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Validation: Definition,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "List Hygiene: What It Is, Why...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Spam Trap: Definition, Types,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Inbox Placement: What It Is, ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Automation: Definition,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Mail Server: Definition, Type...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Quality Score: What It ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Click-Through Rate (CTR): Mea...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Reputation Monitoring: What I...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Open Rate: What It Mean...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Transactional Emails: Definit...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Queued Emails: What They Are,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Delivery Rate: Definition, Fa...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Deliverability Rate: De...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Appending: Definition, ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Phishing: Definition, How It ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Throttling: Definition ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "MX Records: Definition, Setup...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Sender Score: Meaning And Why...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "ESP: Definition, Main Feature...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Encryption: Definition,...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "SMTP Check: Meaning & How It ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Blacklist: What It Is, ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Doble Opt-In: Qué Es, Cómo Fu...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Accept-All Domain: Qué Signif...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Email Blast: Qué Es, Cuándo U...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Pruebas A/B en Correos Electr...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Campañas Drip: Qué Son, Etapa...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Tasa de Rebote en Email: Qué ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "DMARC: Qué Es, Cómo Funciona ...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "DKIM: Qué Es, Cómo Funciona y...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Autenticación de Correo Elect...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Tasa de Conversión: Qué Es, P...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Campaña de Email: Qué Es y Pa...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Automatización de Correos: Qu...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Tasa de Entrega: Qué Es, Fact...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Tasa de Entregabilidad: Qué E...
    • yamlarray:3 [ "message" => "Using a colon in the unquoted mapping value "Lista Negra de Correos: Qué E...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...
    • twigarray:4 [ "message" => "Calling "loop" on template "partials/doc-menu.html.twig" from template "pa...