Consent Control is a privacy management Application Suite with API support that manages consumer opt-outs, integrates with many of the leading third party privacy agencies (who we have already vetted), and offers significant benefits by ensuring compliance with data protection regulations and enhancing consumer trust. By automating the opt-out process, Consent Control reduces administrative burdens, costs of human labor to manage, and minimizes the risk of error. The API provides a seamless, user-friendly experience integration to our secured cloud to capture and manage all opt outs received.
Additionally, the API’s real-time updates ensure that businesses stay current with evolving privacy laws, avoiding costly fines and reputational damage.
Daily, weekly or monthly suppression files are then returned to the customer. Optional available uploads are industry wide opt outs from other data providers who also have integrated to Consent Control (requires a data sharing agreement).
All requests are performed via API POST action and require certain elements to be present in the JSON body based on which elements are presented. The ENDPOINT will allow for saving of Source\Client IP address and Referrer URL (if the functionality is contained within a white labeled page or iFrame).
| Item | Description | Example |
|---|---|---|
| API Endpoint | URL of request | https://{hostname}.digitalsegment.com/RestServices/OptOut/Upload |
| API Key (required header) | Generated for use within your account | Key = "api-key", Value="abc345kk8sdfsdf" |
| JSON Body elements | Passthrough Elements | "projectid" - used in tracking a specific campaign or process for easier record identification. |
Example URL:
https://{host}.digitalsegment.com/RestServices/OptOut/Upload
Sample JSON Post Body
Required Header: api-key. This header is used for authentication.
[
{
"firstname": "John",
"lastname": "Doe",
"address1": "123 Main St",
"address2": "APT 23",
"city": "Sarasota",
"state": "FL",
"zip": "34323",
"phone1": "941-867-5309",
"phone2": "(727) 867-5309",
"email1": "john.doe@gmail.com",
"email2": "johndoe@gmail.com",
"validation": "1",
"projectid": "Test Campaign"
},
{
"firstname": "John",
"lastname": "Does",
"address1": "128 Main St",
"address2": "APT 28",
"city": "Sarasota",
"state": "FL",
"zip": "34323",
"phone1": "941-867-5308",
"phone2": "(727) 867-5308",
"email1": "john.doe8@gmail.com",
"email2": "johndoe8@gmail.com",
"validation": "1",
"projectid": "Test Campaign"
}
]
Each POST can contain up to 100 individual Opt-Out/Unsubscribe requests per transaction. All fields/elements are case sensitive. Many individual fields/elements are not required; however, when presenting certain fields/elements, many other field would be required. More details below for specific field/element pairings and definitions.
| Field/Element | Description | Max Size | Required |
|---|---|---|---|
| firstname | First Name of the consumer | 45 | No |
| lastname | Last Name of the consumer | 45 | No |
| address1 | First Line Address of the consumer | 60 | No |
| address2 | Second Line of Address (APT or Suite) | 45 | No |
| city | City of Address | 45 | No |
| state | State of Address | 2 | No |
| zip | 5 digit zipcode or zip5-zip4 of address | 10 | No |
| phone1 | Phone Number | 15 | No |
| phone2 | Phone Number | 15 | No |
| email1 | Email Adress | 200 | No |
| email2 | Email Adress | 200 | No |
| validation | Validation Status of record. See allowed values below | 1 | Yes |
| projectid | Internal Project reference. Can be used to delineate source of record as needed | 20 | No |
Each component of the Input post is returned in a JSON formatted response with additional detail for the transaction as well as the individual record details. Sample full response below:
{
"status": true,
"transaction_id": "ca58b0e3-94c3-4c24-a8b8-bc4fe3c4c2af",
"successful": 1,
"unsuccessful": 1,
"unsuccessful_ids": [1],
"results": [
{
"firstname": "John",
"lastname": "Doe",
"address1": "25100 Sandhill BLVD",
"address2": "APT V101",
"city": "Punta Gorda",
"state": "FL",
"zip": "33984",
"phone1": "941-867-5309",
"phone2": "(727) 867-5309",
"email1": "john.doe@gmail.com",
"email2": "johndoe@gmail.com",
"validation": "1",
"projectid": "Test Campaign1",
"recordID": "f7612c21-3305-452b-aa68-24af569e5daa",
"successful": true
},
{
"firstname": "John",
"lastname": "Does",
"address1": "128 Main St",
"address2": "APT 28",
"city": "Sarasota",
"state": "FL",
"zip": "34323",
"phone1": "941-867-5308",
"phone2": "(727) 867-5308",
"email1": "john.doe8@gmail.com",
"email2": "johndoe8@gmail.com",
"validation": "2",
"projectid": "Test Campaign2",
"successful": false,
"unsuccessful_reason": "Invalid Address"
}
]
}