Consent Permissions
In 4Comply, Compliance Input refers to the voluntary agreement or approval for a specific activity, captured as a binary value, i.e., Yes or No. Permission is the authorization to perform an action; broader in definition than Compliance Input.
To add consent to a Digital Citizen, you can integrate external forms following these steps and make an API call to the POST /citizens/complianceInput endpoint or use 4Comply Standard Forms. Whichever option you choose, the result will be the same.
If you have a webhook enabled for the “ComplianceInputEntryCreated” trigger, you will receive a webhook containing the full Consent object after POSTing a compliance input request via the API. You will not receive webhooks for individual consent entries in a Bulk Request.
Adding compliance input for a Digital Citizen will create permissions for it based on the Permissions Evaluator.
The Permissions Evaluator processes the compliance input request as follows:
- Check for existing permissions which share the same permission_type
- If no matching permission exists for the Digital Citizen, 4Comply creates new permissions entries
- If permission with the same type exists for the Digital Citizen, 4Comply checks the Time-To-Live (TTL) for those permissions
- If the TTL is before that of the new entry, 4Comply updates the permission with the new TTL.
- If the TTL is later than the new entry, it leaves the existing permission.
You can check permissions for any Digital Citizen by permission type using the GET /citizens/permissions/{email}/{permission_type} endpoint with the Citizen’s email and consent type as parameters.
You can refer to the API Reference for more information.