Skip to main content
IP Whitelisting is a security feature that restricts access to the Rewards API to approved IP addresses. Once enabled, only API requests originating from whitelisted IP addresses are accepted. Requests from any other IP address are rejected. This feature helps organizations secure their API integrations and ensure that only trusted servers can communicate with the Rewards API.

​
Benefits of IP Whitelisting

IP Whitelisting can help organizations:
  • Secure access to the Rewards API.
  • Restrict API requests to trusted servers or networks.
  • Prevent unauthorized access to API credentials.
  • Meet internal security and compliance requirements.

​
How It Works

After one or more IP addresses are whitelisted:
  • API requests from approved IP addresses are processed normally.
  • API requests from any other IP address are rejected.
  • Changes to the IP allowlist take effect immediately.
If a request is made from an IP address that is not on the allowlist, the API returns an error indicating that the request originated from a non-whitelisted IP address.
Example: If your organization whitelists the public IP addresses of its office network or application servers, only requests originating from those IP addresses can access the Rewards API. Requests from any other location are blocked.

​
Add a Whitelisted IP Address

To add an IP address to the allowlist:
1

Navigate to Settings > API > Rewards API

2

Scroll to the IP Whitelisting section

3

Enter the IPv4 address to be whitelisted

4

Click Add

The IP address is added to the allowlist and can immediately be used to access the Rewards API.

​
Manage Whitelisted IP Addresses

Organizations can whitelist multiple IP addresses to support different servers or environments. To remove an IP address:
1

Navigate to the IP Whitelisting section

2

Locate the IP address in the list

3

Click Delete

Once removed, requests originating from that IP address are no longer authorized to access the Rewards API.