Consent event delegates

Delegates are third-parties that modify the consents for an end-user and that you want to keep track of. They can be an internal team or user that have been given access to the Didomi API. The third-party is a "delegate" who is doing modifications on behalf of the end user. Delegate information is optional and can be added to the event to keep track of the modification and its source for audit purposes.

Provide the delegate property when creating a consent event to indicate that the event was created by a delegate. You can specify the ID and name of the delegate, and use a generic metadata field to keep track of extra information on the delegate.

Example - Tracking an internal employee ID and their department when an event is created

POST /consents/events?organization_id={organization_id}

BODY
{
  "user": {
    "organization_user_id": "[e-mail]",
    "metadata": {
      "custom_key": "value"
    }
  },
  
  "consents": {
    "purposes": [
      {
        "id": "purpose_id",
        "enabled": true
      }
    ]
  },
  
  "delegate": {
    "id": "<Internal ID to identify the delegate>",
    "name": "<Name of the delegate>",
    "metadata": {
      // Custom metadata of the delegate
      "department_id": "...",
      "country": "..."
    }
  }    
}

Delegates can also be used with consent tokens.