Skip to main content

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, used to determine if they were given consent in a one-to-one manner. Normalized to be case-insensitive, ignore extra spaces, and omit non-alphanumeric characters (e.g., “Acme Inc.” and “acme inc” are the same). 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.

Example:

"Acme Inc."

​
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.

Example:

7

​
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.

Example:

16

​
opt_in_types_allowed
enum<string>[]

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. 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.

Available options:
manual,
pre-selected,
non-interactive