Verify IP

Use this API to verify location, proxy details, city risk score, and proxy type risk score of an IP address. View the test data and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.

Response Codes

Sub Code	Status	Message	Next Action
200	SUCCESS	VALID	-
400	ERROR	x-client-id is missing in the request.	Enter all the header information in the request.
400	ERROR	verification_id already exists.	Enter a unique verification ID to identify the request.
400	ERROR	Client secret belongs to test environment	Enter the correct environment credentials in the request.
400	ERROR	please enter a valid IP address	Enter a valid IP address in the request.
401	ERROR	Invalid clientId and clientSecret combination	Ensure you enter valid x-client-id and x-client-secret information in the API request.
403	ERROR	IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification	Whitelist the IP address.
404	ERROR	unable to find IP details	Enter a valid IP address in the request.
422	ERROR	Insufficient balance to process this request	Try again with sufficient balance.
500	ERROR	something went wrong, please try after some time	Try again after some time.

Authorizations

x-client-id · string · header · required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret · string · header · required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-cf-signature · string

Send the signature if two-factor authentication is selected as Public Key. More details

Body

application/json

Find the request parameters to retrieve location information of an IP address

ip_address · string · default: 1.0.171.255 · required

It is the IP address that you need to verify which is assigned to a device connected to a computer network.

Example:

"1.0.171.255"

verification_id · string · default: testverificationid · required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"testverificationid"

Response

200

application/json

IP verified successfully

reference_id · integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

Example:

1358

verification_id · string

It displays the unique ID you created to identify the verification request.

Example:

"testverificationid"

status · string

It displays the status of the IP address.

Example:

"VALID"

ip_address · string

It displays the entered IP address.

Example:

"1.0.171.255"

proxy_type · string

It displays the category or classification of a proxy server based on its functionality and how it handles network requests.

Example:

"VPA"

country_code · string

It displays the country code associated with the geographical location of the device or network to which the IP address is assigned.

Example:

"TH"

country_name · string

It displays the name of the country associated with the geographical location of the device or network to which the IP address is assigned.

Example:

"Thailand"

region_name · string

It displays the name of the region associated with the geographical location of the device or network to which the IP address is assigned.

Example:

"Phangnga"

city_name · string

It displays the name of the city associated with the geographical location of the device or network to which the IP address is assigned.

Example:

"Phang Nga"

city_risk_score · string

It displays the risk score associated with a particular city based on factors such as cybersecurity threats, crime rates, or other relevant data.

Example:

"0"

proxy_type_risk_score · string

It displays the risk score associated with a particular city based on factors such as cybersecurity threats, crime rates, or other relevant data.

Example:

"0"