Verify

The verify operation uses data from lead events and the source from which they originated to verify that a consumer gave their express written consent to be contacted as defined by the requirements configured in your account.

Important

  • Verify requires a Self-Service plan or higher.
  • For Facebook certificates, consent language is detected only if it is included in the custom disclaimer section.

VerifyParameters

The advertiser_name parameter is optional but is required to populate the one_to_one property.

The advertiser_name parameter only applies to the One to One Consent value (returned as one_to_one). It has no effect on any other values returned by the Verify call.

The min_font_size_px_required, min_contrast_ratio_required, and opt_in_types_allowed parameters are optional.

advertiser_name
string

The name of the legal entity for an advertiser that will be used to determine if they were given consent in a one to one manner. This value will be normalized to be case insensitive, ignore redundant white space and omit non-alphanumeric characters. Both 'Acme Inc.' and 'acme inc' would result in the same processed value.

min_contrast_ratio_required
number

Specifies the minimum contrast ratio that must be present between the consent language font color and its background. This helps ensure that the text is clearly visible against the background, meeting accessibility and visibility standards.

min_font_size_px_required
number

Specifies the minimum font size (in pixels) that the consent language must meet. Consent languages that do not meet this minimum font size will fail the check.

opt_in_types_allowed
Array of strings

An array of strings specifying the opt-in types that are accepted. The array can include one or more of the following values:

  • manual: The consumer actively checked a box to provide consent.
  • pre-selected: An opt-in field was selected by default, without explicit action from the consumer.
  • non-interactive: In the absence of an opt-in field, the consumer gave consent by submitting the form.

This field is used to define which opt-in types are considered valid.

Items Enum: "manual" "pre-selected" "non-interactive"
{
  • "advertiser_name": "Acme Inc.",
  • "min_contrast_ratio_required": 7,
  • "min_font_size_px_required": 16,
  • "opt_in_types_allowed": [
    • "manual",
    • "pre-selected",
    • "non-interactive"
    ]
}

VerifyResult

advertiser_name
string

The legal name of the advertiser used to perform the 1:1 consent language check. This value can be passed in the request or set via the verification criteria page and will appear in the response if provided in either.

Array of objects

A list of the consent languages detected within the certificate

min_contrast_ratio_required
number

The number indicating the minimum contrast ratio required between the consent language text and background. This value can be passed in the request or set via the verification criteria page and will appear in the response if provided in either.

min_font_size_px_required
number

The number indicating the minimum font size required for the consent language. This value can be passed in the request or set via the verification criteria page and will appear in the response if provided in either.

opt_in_types_allowed
Array of strings

An array of strings that lists the opt-in types that are allowed. This value can be passed in the request or set via the verification criteria page and will appear in the response if provided through either method.

Items Enum: "manual" "pre-selected" "non-interactive"
object

An object containing properties that detail the result of the verify operation.

{
  • "advertiser_name": "Acme Inc.",
  • "languages": [
    • {
      • "text": "By clicking on the 'Get Rates' button below, I consent to be contacted"
      }
    ],
  • "min_contrast_ratio_required": 7,
  • "min_font_size_px_required": 16,
  • "opt_in_types_allowed": [
    • "manual",
    • "pre-selected",
    • "non-interactive"
    ],
  • "result": {
    • "form_submitted": true,
    • "language_approved": true,
    • "min_contrast_ratio_satisfied": true,
    • "min_font_size_px_satisfied": true,
    • "one_to_one": true,
    • "opt_in_types_satisfied": true,
    • "success": true
    }
}