> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zbdpay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a User

> Read a user's details and whether they're verified.

Use this to check whether a user has completed identity verification before you let them cash out or pay them.

## Configuration

### Header Parameters

**x-api-key** `string` *required*

Your ZBD API key.

### Path Parameters

**userId** `string` *required*

The ZBD user ID returned by Create a User.

```bash cURL theme={null}
curl https://api.zbdpay.com/api/v1/users/4ac4fd8a-cc2c-4d03-af09-a76f4e89d652 \
  -H "x-api-key: YOUR_API_KEY"
```

```json 200 theme={null}
{
  "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 in `data`. [Create a User](https://docs.zbdpay.com/embedded-payouts/apis/create-user.md) and [Update a User](https://docs.zbdpay.com/embedded-payouts/apis/update-user.md) return the same fields.

**user\_id** `string`

ZBD's ID for the user. Send it on every other call about this user.

**publisher\_user\_id** `string`

Your own ID for the user, as you sent it on Create a User.

**email** `string | null`

The user's email address, if you sent one. ZBD uses it to send verification codes in the widget.

**kyc\_status** `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.

**created\_at** `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 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.