curl https://api.zbdpay.com/api/v1/users/{userId}/disclosures \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Disclosures retrieved.",
"data": [
{
"type_id": 6,
"name": "Electronic Funds Transfer",
"version": "1.0.0",
"current": false,
"accepted_at": null
}
],
"error": null
}
Users
Get Disclosures
Read which disclosures a user has accepted.
GET
/
api
/
v1
/
users
/
{userId}
/
disclosures
curl https://api.zbdpay.com/api/v1/users/{userId}/disclosures \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Disclosures retrieved.",
"data": [
{
"type_id": 6,
"name": "Electronic Funds Transfer",
"version": "1.0.0",
"current": false,
"accepted_at": null
}
],
"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). If they haven’t, the payout returns 422 disclosure_required.
Configuration
Header Parameters
string
required
Your ZBD API key.
Path Parameters
string
required
The ZBD user ID returned by Create a User.
curl https://api.zbdpay.com/api/v1/users/{userId}/disclosures \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Disclosures retrieved.",
"data": [
{
"type_id": 6,
"name": "Electronic Funds Transfer",
"version": "1.0.0",
"current": false,
"accepted_at": null
}
],
"error": null
}
current is true when the user has accepted the latest version of that disclosure.
Errors
| HTTP | code | When |
|---|---|---|
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?