Skip to main content
GET
/
api
/
v1
/
widget
/
users
/
{userId}
/
disclosures
curl https://api.zbdpay.com/api/v1/widget/users/{userId}/disclosures \
  -H "apikey: YOUR_API_KEY"
{
  "success": true,
  "message": "Publisher user ToS status retrieved successfully.",
  "data": [
    {
      "type_id": 2,
      "name": "Terms of Service",
      "version": "1.4.0",
      "tos_current": true,
      "accepted_at": "2026-01-15T12:00:00Z"
    },
    {
      "type_id": 6,
      "name": "Electronic Funds Transfer",
      "version": "1.0.0",
      "tos_current": false,
      "accepted_at": null
    }
  ],
  "error": null
}

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

apikey
string
required
Your ZBD project API key.

Path Parameters

userId
string
required
The ZBD user ID returned when the widget user is created or resolved.
curl https://api.zbdpay.com/api/v1/widget/users/{userId}/disclosures \
  -H "apikey: YOUR_API_KEY"
{
  "success": true,
  "message": "Publisher user ToS status retrieved successfully.",
  "data": [
    {
      "type_id": 2,
      "name": "Terms of Service",
      "version": "1.4.0",
      "tos_current": true,
      "accepted_at": "2026-01-15T12:00:00Z"
    },
    {
      "type_id": 6,
      "name": "Electronic Funds Transfer",
      "version": "1.0.0",
      "tos_current": false,
      "accepted_at": null
    }
  ],
  "error": null
}
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

StatusReason
401Missing or invalid API key
403The API key is not allowed to access widget disclosure APIs
404userId does not belong to the project associated with the API key