Skip to main content

​
Email Type

The Email object is the request body for the Submit Email and Submit Email Batch endpoints. It contains the email address to analyze, an optional flag to enable identity intelligence, and optional identity claims.

​
Structure

FieldTypeRequiredDescription
emailstringYesThe email address to analyze
identity_intelligencebooleanNoWhen true, enables deeper identity analysis including online presence detection, connected identity discovery, and claims verification. Defaults to false.
claimsobjectNoIdentity claims to verify against data linked to the email. Only meaningful when identity_intelligence is true.

​
Claims

Claims represent information your customer has provided that you want to verify against independent data sources. When identity_intelligence is enabled, Verisoul matches these claims against identity data linked to the email and reports whether each claim matches, partially matches, or does not match.
FieldTypeDescription
nameobjectThe expected name of the email owner. You can provide first, last, or both.
name.firststringFirst name (e.g., "John")
name.laststringLast name (e.g., "Doe")
phonestringPhone number in a valid format. E.164 is recommended.
countrystringTwo-letter country code (ISO 3166-1 alpha-2).

​
Name

You can provide a first name, a last name, or both. Verisoul compares the provided name(s) against names associated with the email across data sources. 
{ "name": { "first": "John", "last": "Doe" } }

{ "name": { "first": "John" } }

{ "name": { "last": "Doe" } }

​
Phone

Provide the phone number in a standard format. E.164 (international with + prefix) is recommended, but national formats are also accepted. Examples:
FormatExample
E.164 (recommended)"+14155551234"
E.164 with country code"+442071234567"
National (US)"(415) 555-1234"
National (UK)"020 7123 4567"

​
Country

Provide the expected country as a two-letter ISO 3166-1 alpha-2 code. Examples:
CodeCountry
"US"United States
"GB"United Kingdom
"CA"Canada
"DE"Germany
"JP"Japan
"BR"Brazil

​
Usage

​
In Submit Email

Claims and identity_intelligence are provided at the top level alongside the email: 
{
  "email": "john.doe@example.com",
  "identity_intelligence": true,
  "claims": {
    "name": { "first": "John", "last": "Doe" },
    "phone": "+14155551234",
    "country": "US"
  }
}

​
In Submit Email Batch

identity_intelligence is set at the top level and applies to all emails. Claims are provided per email, allowing you to verify different identities in a single batch: 
{
  "emails": [
    {
      "email": "john.doe@example.com",
      "claims": {
        "name": { "first": "John", "last": "Doe" },
        "country": "US"
      }
    },
    {
      "email": "jane@company.com",
      "claims": {
        "name": { "first": "Jane" },
        "phone": "+442071234567"
      }
    }
  ],
  "identity_intelligence": true
}