Skip to main content
POST
/
ip
Verify IP
curl --request POST \
  --url https://sandbox.cashfree.com/verification/ip \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "ip_address": "1.0.171.255",
  "verification_id": "testverificationid"
}
'
{
  "value": {
    "reference_id": 1358,
    "verification_id": "testverificationid",
    "status": "VALID",
    "ip_address": "1.0.171.255",
    "proxy_type": "VPA",
    "country_code": "TH",
    "country_name": "Thailand",
    "region_name": "Phangna",
    "city_name": "Phang Nga",
    "city_risk_score": "0",
    "proxy_type_risk_score": "0"
  }
}
Sub codeStatusMessageNext action
200SUCCESSVALID-
400ERRORx-client-id is missing in the request.Enter all the header information in the request.
400ERRORverification_id already exists.Enter a unique verification ID to identify the request.
400ERRORClient secret belongs to test environmentEnter the correct environment credentials in the request.
400ERRORplease enter a valid IP addressEnter a valid IP address in the request.
401ERRORInvalid clientId and clientSecret combinationEnsure you enter valid x-client-id and x-client-secret information in the API request.
403ERRORIP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our IP Whitelisting guideWhitelist the IP address.
404ERRORunable to find IP detailsEnter a valid IP address in the request.
422ERRORInsufficient balance to process this requestTry again with sufficient balance.
500ERRORsomething went wrong, please try after some timeTry 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

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"