Consent logs

  "consent_key": "all-the-things",
  "consent_title": "all the things",
  "consent_type": "opt-out",
  "consent_version": {
    "language": "fr",
    "version_id": 1
  "date": "2021-10-25T13:34:54.000Z",
  "granted": false,
  "waiting_double_accept": true,
  "id": "AXy3qUft…​AqIjInslG",
  "is_group": false,
  "source": {
    "canal": "job",
    "id": "AXy3q…​qIjInslF",
    "name": "update user consents",
    "reporter": "managed",
  "user_id": "AXy3qR..IjInsk9"
Name Description


The consent key.

Uniquely identifies a Consent. This key is used to reference the Consent in the ReachFive SDK or API.


The consent title.

This is what the user reads to decide to opt-in or opt-out.


Specifies the Consent type.

  • opt-in: requires an explicit action by the user on signup.

  • opt-out: is automatically accepted on user signup. If a user does not want to accept the given processing purpose, the user must explicitly opt out of it.

  • doi: an explicit action by the user with an additional step required here where the user (via SMS or email) must confirm the choice to opt-in, adding further peace of mind and security for your users.


The version of the consent.

Consent versions allow you to offer different versions of a single Consent. For example, if you need to what is accepted in the Consent, but the Consent is standard across your offerings, creating a new Consent version allows you to manage this from one place in the ReachFive Console.

When creating a Consent, Version 1 is automatically available to you where you (at a minimum) add the translation for your default account language.


The date the consent log was created.


A boolean specifying the consent was granted or not.


Boolean specifiying whether we are still awaiting the double opt-in confirmation from the user.


The unique ID for the specific consent log.


A boolean that specifies if this particular consent is part of a larger consent group.


An object that contains information regarding the source of the consent log.

Field Description

channel (canal)

The channel through which the consent came. This could be a job that was run or through the API.


The ID for the source channel (canal).


The source name.


Specifies the reporter who made the modification. For example, this could be an administrator for your site or even an import being executed.

This is an optional field and isn’t always applicable.


The ID of the user that exported the consent log.