Widget SDK Reference
Last updated: March 19, 202610 min readAdvancedDeveloper
The Arqam360 consent widget exposes a rich configuration API and JavaScript interface. This reference covers all available options.
Configuration Options
javascript
<script data-key="YOUR_KEY"
data-regime="gdpr"
data-auto-regime="true"
data-enforce-blocking="true"
src="https://cdn.arqam360.com/widget-v2.js">
</script>Data Attributes
- data-key — Your API key (required)
- data-regime — Force a specific regime: gdpr, pdpl, uae_pdpa, ccpa, lgpd, pipeda, none
- data-auto-regime — Enable automatic regime detection via IP geolocation (true/false)
- data-enforce-blocking — Enable script/request/cookie quarantine (true/false)
- data-lang — Override default language (en/ar)
- data-consentiq-bypass — Add to any script tag to skip interception
JavaScript API
javascript
// Access the widget API
window.consentiq.getConsent() // Returns current consent state
window.consentiq.showBanner() // Re-show the consent banner
window.consentiq.showPreferences() // Open preference center
window.consentiq.reset() // Clear consent and re-show bannerEvents
- consentiq:ready — Widget initialized
- consentiq:consent — Consent state changed
- consentiq:banner:show — Banner displayed
- consentiq:banner:hide — Banner hidden
Event Callbacks
javascript
window.addEventListener('consentiq:consent', (e) => {
console.log('Consent updated:', e.detail);
// e.detail.analytics, e.detail.marketing, etc.
});Add data-consentiq-bypass="true" to any script tag that should never be blocked by the quarantine system.
Was this article helpful?