curl https://api.zbdpay.com/api/v1/users/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652 \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "User retrieved.",
"data": {
"user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
"publisher_user_id": "user-42",
"email": "user@example.com",
"kyc_status": "verified",
"created_at": "2026-10-01T18:00:00Z"
},
"error": null
}
Users
Get a User
Read a user’s details and whether they’re verified.
GET
/
api
/
v1
/
users
/
{userId}
curl https://api.zbdpay.com/api/v1/users/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652 \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "User retrieved.",
"data": {
"user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
"publisher_user_id": "user-42",
"email": "user@example.com",
"kyc_status": "verified",
"created_at": "2026-10-01T18:00:00Z"
},
"error": null
}
Use this to check whether a user has completed identity verification before you let them cash out or pay them.
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/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652 \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "User retrieved.",
"data": {
"user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
"publisher_user_id": "user-42",
"email": "user@example.com",
"kyc_status": "verified",
"created_at": "2026-10-01T18:00:00Z"
},
"error": null
}
Response
The user is indata. Create a User and Update a User return the same fields.
string
ZBD’s ID for the user. Send it on every other call about this user.
string
Your own ID for the user, as you sent it on Create a User.
string | null
The user’s email address, if you sent one. ZBD uses it to send verification codes in the widget.
string
Where the user is in identity verification:
not_started, pending (submitted and being reviewed), verified, or rejected. A user has to be verified before they can be paid.string
When the user was created, as an ISO 8601 timestamp.
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?