curl -X POST https://api.zbdpay.com/api/v1/users/{userId}/disclosures \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "accepted_disclosure_type_ids": [6] }'
{
"success": true,
"message": "Disclosures recorded.",
"data": { "accepted_disclosure_type_ids": [6] },
"error": null
}
Users
Record Disclosures
Record that a user accepted the latest version of one or more disclosures.
POST
/
api
/
v1
/
users
/
{userId}
/
disclosures
curl -X POST https://api.zbdpay.com/api/v1/users/{userId}/disclosures \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "accepted_disclosure_type_ids": [6] }'
{
"success": true,
"message": "Disclosures recorded.",
"data": { "accepted_disclosure_type_ids": [6] },
"error": null
}
Most programs don’t need this endpoint. The widget asks the user to accept the Electronic Funds Transfer agreement when they add a US bank account. This endpoint is for specific cases, such as a program that runs its own front end instead of the widget. If that’s you, talk to your ZBD contact during onboarding.
6, the Electronic Funds Transfer disclosure.
Configuration
Header Parameters
string
required
Your ZBD API key.
string
Content Type
Path Parameters
string
required
The ZBD user ID returned by Create a User.
Body Parameters
integer[]
required
The disclosure types the user accepted, for example
[6].curl -X POST https://api.zbdpay.com/api/v1/users/{userId}/disclosures \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "accepted_disclosure_type_ids": [6] }'
{
"success": true,
"message": "Disclosures recorded.",
"data": { "accepted_disclosure_type_ids": [6] },
"error": null
}
Errors
| HTTP | code | When |
|---|---|---|
400 | validation_failed | The list is empty or has an unknown type |
401 | unauthorized | The API key is missing or invalid |
404 | user_not_found | The user doesn’t exist under your key |
Was this page helpful?