Jump to Content
Guides
API Reference
Sign-Up
Recipes
Home
Guides
API Reference
Changelog
v4.0
Guides
API Reference
Sign-Up
Recipes
Log In
API Reference
Log In
v4.0
API Reference
Create citizens in bulk, up to 1000 at a time.
Search
All
Pages
Start typing to search…
JUMP TO
Permissions
Data Lists
Updates a new Data List Item by Id
patch
Fetches a single Data List Item by Id
get
Deletes a Data List Item by Id
delete
Creates a new Data List Item
post
Free-form search across properties in the lists
get
Updates a new Data List Item by Reference
patch
Fetches a single Data List Item by Reference
get
Deletes a Data List Item by Reference
delete
Objection Configurations
Get audit information
get
Get an Objection Configuration
get
Updates an Objection Configuration
put
Creates an Objection Configuration
post
Get Objection Configuration for an application
get
Objection Management
Get filtered objections for an Application Id
get
Get audit information for a given objection
get
Update an objection
patch
Permission Statement Links
Creates a Statement Link
post
Retrieves Statement Links.
get
Retrieves Statement Link by Reference
get
Updates a Statement Link
put
Patches a Statement Link
patch
Permission Statements
Creates a Permission Statement
post
Retrieves Permission Statements.
get
Updates a Permission Statement status
patch
Retrieves Permission Statement by ID
get
Permissions (Effective & Latest)
Retrieve a citizen's 'effective' permissions for the given arguments
get
Permissions and Preferences Store
Retrieves effective Permissions and Preferences for an Application.
get
Retrieves effective Permissions and Preferences for an Application.
get
Privacy Policies
Update a Privacy Policy
patch
Get a Privacy Policy by its Id
get
Create a Policy Permit
post
Create a Privacy Policy
post
Get Privacy Policies
get
Register an Externally Managed Privacy Policy
post
Consent State
Submit updated Consent State for a Citizen
post
Get Consent State for a Citizen
get
Stateless Submissions
Stateless Submission endpoint
post
Permission Statement Links History
Get statement link histories.
get
Permissions Configuration
Retrieve the configuration for the given application
get
Updates a configuration for the given application
put
Permissions Transactions
Creates transactions.
post
Retrieve transactions.
get
Retrieve the transaction for the given id.
get
Privacy Policies
Redirect to latest revision of public PrivacyPolicy.
get
Get Public Privacy Policies
get
Citizens
Citizens
Retrieves Job by ID.
get
Creates a Citizen Deletion Job
post
Retrieves a page of Jobs.
get
Splits a citizen
post
Retrieve a Citizen by its Id
get
Retrieve a page of citizens for the given Application
get
Create citizens in bulk, up to 1000 at a time.
post
Retrieve the number of citizens, associated with the given Application
get
Delete a single citizen by Citizen ID
delete
Update a citizen
put
Create a citizen
post
Query Citizens
get
Delete a single citizen by Application ID and External Reference
delete
Citizen Email Lookup
Lookup citizen email address
get
Create or update citizen details
put
Lookup citizen external ref
get
Linked Citizens
Retrieves a page of linked citizen groups.
get
Link citizens to form a group
post
Get a group of linked citizens by reference.
get
Unlink a citizen from a group by reference
delete
Merge Requests
Merge a single citizen
post
Retrieves all merges associated with the specified citizen or application
get
Initiates a citizen merge job
post
Returns all citizen merge jobs for a specified Application Id
get
Returns information about a specific job
get
Returns information about a specific job
get
Retrieves a citizen merge
get
Citizens
Retrieves failure details for Job in CSV format.
get
Imports, exports and syncing
Captured Transactions Import
Imports Citizens, Transactions, Preferences and Email Addresses.
post
Retrieves all Jobs.
get
Retrieves Job by ID.
get
Retrieve import job failures. NB: failure details are only available for 90 days.
get
Citizen Capture
Get captured citizen's details for the given ApplicationId.
get
Capture a citizen's details.
post
Export Jobs
Retrieves all Jobs for Application
get
Create a job to export permissions store data
post
Retrieves Job by id
get
Linked Citizens Import
Retrieve Linked Citizens import Job failures. NB: failure details are only available for 90 days.
get
Retrieve Linked Citizens import Job.
get
Import a CSV file of Linked Citizens.
post
Subscriptions
Update fields for a Subscription by ID
patch
Get Subscription by ID
get
Delete a Subscription by ID
delete
Update a Subscription by ID
put
Get audit information
get
Create a Subscription
post
Get all subscriptions filtered by Application ID
get
Get all subscription failures filtered by Application Id
get
Delete subscription failures filtered by Application Id and SubscriptionId
delete
Transaction Capture
Deletes Transactions by unique reference(s).
post
Imports Transactions directly into the DataGuard Consent and Preference Management platform.
post
Deletes Transactions.
delete
Creates an unauthenticated Transaction.
post
Retrieves unauthenticated Transactions.
get
Preferences
Preferences Configuration
Define a preference
post
Get all preferences
get
Get a preference
get
Update a preference
put
Delete a preference
delete
Preference Submissions
Submit a citizen preference
post
Get preference submissions
get
Get a citizen submission
get
Preferences
Get preferences for an application
get
Preferences Configuration History
Get all history for preference configuration
get
Get history for a specific preference configuration
get
Customer Engagement
Access Tokens
Deletes the tokens generated for the Job.
delete
Creates a Job to generate Access Tokens.
post
Retrieves the event logs.
get
Revokes a Job and deletes the associated tokens
delete
Create a single access token for a specific citizen
post
Authorisation
Revoke a single Access Token
post
Branding
Get the branding style.
get
Update the branding. Note that if root objects like `styles` or `cardLayout` do not provided child attributes they are NOT overwritten.
put
Get all branding history.
get
Templates History
Get template history
get
Get full template history (not paginated)
get
Templates
Retrieves Templates.
get
Creates a Template
post
Retrieves Template by ID
get
Updates Template by ID
put
Updates Template status
patch
Widget Rules
Update a set of rules
put
Define a new set of rules
post
Get all rules.
get
Get a set of rules
get
Delete a set of rules
delete
Widgets
Get all Widgets.
get
Create a Widget
post
Get a Widget by ID
get
Update a Widget by ID
put
Delete a Widget by ID
delete
Get all Widgets histories.
get
Get a Widget's history by ID
get
Access Tokens
Retrieves all Jobs.
get
Retrieves Job by ID.
get
Retrieves the tokens generated for a Job as CSV.
get
Powered by
Create citizens in bulk, up to 1000 at a time.
post
https://api.consentric.io/v1/bulkCitizens
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
