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
}
API Reference
Get Disclosure Status
Check a widget user’s current disclosure acceptance status.
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. The response can include disclosures that are not required by the widget. For widget ACH cashout, inspect Electronic Funds Transfer type6 only. If its
tos_current value is false, present the current EFT document and record
acceptance with Submit Disclosure Acceptance.
Types 1 through 5 can be ignored for widget eligibility and do not block
cashout. No disclosure type is checked during widget session creation. Do not
call this endpoint from a browser, mobile client, game client, or WebView.
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
string
required
Your ZBD project API key.
Path Parameters
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. For widget ACH eligibility, only the value on type 6 is relevant.
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 |
Was this page helpful?