POST
/
ip
{
  "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"
  }
}

Authorizations

​
x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Body

application/json

Find the request parameters to verify 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.

​
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.

Response

200 - application/json

Verify IP success response

​
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.

​
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.

​
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.

​
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.

​
ip_address
string

It displays the entered IP address.

​
proxy_type
string

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

​
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.

​
reference_id
integer

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

​
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.

​
status
string

It displays the status of the IP address.

​
verification_id
string

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

Was this page helpful?

Verify GSTINLiveliness Check