API Reference
Get Disclosure Status
Check a widget user’s current disclosure acceptance status.
GET
Description
Returns the user’s acceptance status for each current disclosure type. Use this from your server only if your integration needs to check disclosure acceptance outside the hosted widget. Most integrations can let the widget handle disclosure prompts during the session. The API key determines the publisher/project context.userId is the ZBD user ID returned when the widget user is created or resolved.
Configuration
Header Parameters
Your ZBD project API key.
Path Parameters
The ZBD user ID returned when the widget user is created or resolved.
tos_current means the user has accepted the current version of that disclosure type. A value of false means there is no acceptance on record, or the user’s latest acceptance is for an older version.
Errors
| Status | Reason |
|---|---|
401 | Missing or invalid API key |
403 | The API key is not allowed to access widget disclosure APIs |
404 | userId does not belong to the project associated with the API key |