Geofencing (IP to address)
Introduction
The Geofencing (IP to address) API offered by Signzy Technologies Private Limited enables users to retrieve geographical information of an IP address. This API accepts an IP address as an input and returns its corresponding geographical details such as country, state, city, zip code, latitude, longitude, timezone, ASN, and risk score. This API can be useful for businesses that need to verify the location of their users or customers, as well as for security purposes. In this documentation, we will provide you with the required information to use this API effectively.
Use Cases
The Geofencing (IP to address) API offered by Signzy Technologies Private Limited can be used in a variety of scenarios, such as:
- IP Verification: Businesses can use this API to verify the location of their users or customers by comparing their IP address with the geographical details returned by the API. This can be helpful for preventing fraud, verifying user identity, and ensuring compliance with local regulations.
- Personalization: By using the location data returned by this API, businesses can personalize their services or products based on the user's location. For example, an e-commerce website can show products that are available in the user's city, or a news website can show news articles relevant to the user's state or country.
- Security: This API can be used for security purposes, such as identifying and blocking suspicious IP addresses. Businesses can use the risk score returned by the API to determine the level of risk associated with an IP address and take appropriate actions.
- Analytics: By analyzing the geographical data returned by this API, businesses can gain insights into their user base and make data-driven decisions. For example, a company can analyze the distribution of its users across different states or countries and use this information to optimize its marketing strategies.
API description
Details of the request properties
Parameter | Type | Required | Description |
|---|---|---|---|
task | string | Yes | The task type, which should be set to "geoFencing". |
essentials.ip | string | Yes | The IP address to geofence, in the format "X.X.X.X". |
essentials.country | string | No | The two-letter ISO country code for the IP address. |
essentials.state | string | No | The state or region name for the IP address, if available. If not available, set this field to an empty string (""). |
Details of the response properties
Property | Example Value | Description |
|---|---|---|
ip | "103.171.99.42" | IP address of the requested location |
country | "INDIA" | Country name of the requested IP address |
countryCode | "IN" | ISO-3166 country code of the requested IP address |
state | "KARNATAKA" | State name of the requested IP address |
stateCode | "KA" | ISO-3166 state code of the requested IP address |
city | "BENGALURU" | City name of the requested IP address |
zipCode | "560027" | Postal code of the requested IP address |
timezone | "IST, Asia/Kolkata" | Timezone of the requested IP address in the format "(timezone abbreviation, timezone name)" |
latitude | 12.95875 | Latitude coordinate of the requested IP address |
longitude | 77.59345 | Longitude coordinate of the requested IP address |
asn | "142477" | Autonomous System Number (ASN) of the requested IP address |
riskip | true | Flag indicating whether the requested IP address is associated with high risk |
validUser | false | Flag indicating whether the requested IP address belongs to a valid user |
Error Codes
Error Code | Description |
|---|---|
400 | Bad Request – This error occurs when the request data is missing or invalid. The error message will indicate the specific issue with the request data. |
401 | Unauthorized – This error occurs when the API key used for authentication is invalid or missing. |
403 | Forbidden – This error occurs when the authenticated user does not have sufficient permissions to access the requested resource. |
404 | Not Found – This error occurs when the requested resource is not found on the server. |
500 | Internal Server Error – This error occurs when there is an issue on the server side. The error message will indicate the specific issue with the server. |
Troubleshooting
Issue | Description | Solution |
|---|---|---|
Invalid IP Address | The IP address provided in the request is invalid or not in the correct format. | Verify that the IP address is in the correct format (IPv4 or IPv6), and try the request again. |
IP Address Not Found | The IP address provided in the request could not be located. | Verify that the IP address is correct, and try the request again. |