curl -X POST https://api.zbdpay.com/api/v1/widget/users/{userId}/disclosures \
-H "apikey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"acceptedDisclosureTypeIds": [6]
}'
{
"success": true,
"message": "Publisher user disclosure agreements recorded successfully.",
"data": {
"acceptedDisclosureTypeIds": [6]
},
"error": null
}
API Reference
Submit Disclosure Acceptance
Record disclosure acceptance for a widget user.
POST
/
api
/
v1
/
widget
/
users
/
{userId}
/
disclosures
curl -X POST https://api.zbdpay.com/api/v1/widget/users/{userId}/disclosures \
-H "apikey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"acceptedDisclosureTypeIds": [6]
}'
{
"success": true,
"message": "Publisher user disclosure agreements recorded successfully.",
"data": {
"acceptedDisclosureTypeIds": [6]
},
"error": null
}
Description
Records the user’s acceptance of the latest version of each disclosure type inacceptedDisclosureTypeIds.
Use this from your server only if your integration collects disclosure acceptance outside the hosted widget. Do not call this endpoint from a browser, mobile client, game client, or WebView.
Configuration
Header Parameters
string
required
Your ZBD project API key.
string
Content Type
Path Parameters
string
required
The ZBD user ID returned when the widget user is created or resolved.
Body Parameters
array
required
Disclosure type IDs accepted by the user. ZBD records acceptance for the latest version of each type.
curl -X POST https://api.zbdpay.com/api/v1/widget/users/{userId}/disclosures \
-H "apikey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"acceptedDisclosureTypeIds": [6]
}'
{
"success": true,
"message": "Publisher user disclosure agreements recorded successfully.",
"data": {
"acceptedDisclosureTypeIds": [6]
},
"error": null
}
Disclosure Type IDs
| Disclosure type | Type ID |
|---|---|
| Terms of Service | 2 |
| Privacy Policy | 3 |
| Electronic Funds Transfer | 6 |
Existing Users
If a user already exists and needs to accept a current disclosure, call this endpoint. Do not rely on an idempotent user-create call to update disclosure acceptance for an existing user.Errors
| Status | Reason |
|---|---|
400 | acceptedDisclosureTypeIds is empty, missing, or contains an unknown disclosure type |
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?