curl -X POST https://api.zbdpay.com/api/v1/users/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652/deletion-request \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Deletion request accepted.",
"data": null,
"error": null
}
Users
Delete a User
Request that a user’s data is archived, for example to handle an erasure request.
POST
/
api
/
v1
/
users
/
{userId}
/
deletion-request
curl -X POST https://api.zbdpay.com/api/v1/users/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652/deletion-request \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Deletion request accepted.",
"data": null,
"error": null
}
Queues the user for archival. It’s a request rather than an immediate delete: ZBD processes it in the background, and the user can’t be used again once it’s accepted.
Use it when a user asks you to erase their data. Check that the request comes from the account holder before you call it, because archival can’t be undone.
A user with open payouts can’t be archived, and a user who still holds a balance has to be paid out or brought to zero first.
Configuration
Header Parameters
string
required
Your ZBD API key.
Path Parameters
string
required
The ZBD user ID returned by Create a User.
curl -X POST https://api.zbdpay.com/api/v1/users/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652/deletion-request \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Deletion request accepted.",
"data": null,
"error": null
}
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 |
409 | payouts_in_flight | The user has payouts that haven’t finished |
Was this page helpful?