<!-- ZenPays documentation · https://docs.zenpayz.com/docs/reference/objects/ipwhitelist-entry -->

# The IPWhitelistEntry object

Represents an IP address in the whitelist. IP whitelisting restricts API access to specific IP addresses for enhanced security.

## Fields

<ParamTable
  label="Field"
  rows={[
    { name: "id", type: "string", required: true, desc: "Unique identifier for the whitelist entry" },
    { name: "merchantId", type: "string", required: true, desc: "ID of the merchant this entry belongs to" },
    { name: "ipAddress", type: "string", required: true, desc: "Whitelisted IP address (IPv4 or IPv6)" },
    { name: "description", type: "string", required: false, desc: "Description to identify this IP address" },
    { name: "isActive", type: "boolean", required: true, desc: "Whether this whitelist entry is active" },
    { name: "createdBy", type: "string", required: true, desc: "User ID who created this entry" },
    { name: "createdAt", type: "string", required: true, desc: "ISO 8601 timestamp when the entry was created" },
  ]}
/>

## Example

```json
{
  "id": "obj_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "ipAddress": "string",
  "description": "string",
  "isActive": false,
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00Z"
}
```