Address Geocode Match

Introduction

Address geocoding, or simply geocoding, is the process of taking a text-based description of a location, such as an address or the name of a place, and returning geographic coordinates, frequently latitude/longitude pair, to identify a location on the Earth's surface. The Address Geocoder product takes the address and returns the latitude/longitude of the shared location.

API details

Endpoint

POST https://api.signzy.app/api/v3/geocoding/address-geocoder

POST https://api-preproduction.signzy.app/api/v3/geocoding/address-geocoder

Request body parameters

Parameter	Data Type	Description	Required
address	String	The address information	Mandatory
latitude	String	Latitude coordinate. It will be utilized alongside the coordinates provided by the API to determine the distance between the two sets of coordinates. Needs to be used with longitude.	Conditionally Mandatory
longitude	String	Longitude coordinate. It will be utilized alongside the coordinates provided by the API to determine the distance between the two sets of coordinates. Needs to be used with latitude.	Conditionally Mandatory

{
    "address": "BTM layout, BENGALURU",
    "latitude": "",
    "longitude": ""
}

Request Headers

Name	Value	Required	Description
Content-type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Code Samples

curl --location 'https://api-preproduction.signzy.app/api/v3/geocoding/address-geocoder' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Authorization Token>' \
--data '{
    "address": "BTM layout, BENGALURU",
    "latitude": "",
    "longitude": ""
}'

Response body parameters

Parameter	Data type	Description
address	String	The complete address including location details
latitude	String	The latitude coordinate of the address
longitude	String	The longitude coordinate of the address
confidenceScore	Integer	The confidence score of the returned coordinates. 1 means precise street address location information, 0.9 means approximations based on road intersections. 0.7 means centered on a location's geometry. 0.5 means broadly estimated.
city	String	The city name
state	String	The state name
stateCode	String	The state code
country	String	The country name
countryCode	String	The country code
zipcode	String	The postal code or ZIP code
distanceInKms	String	Distance in kilometers from the latitude and longitude provided in the input request body.

{
    "address": "BTM LAYOUT, BENGALURU, KARNATAKA, INDIA",
    "latitude": "12.91495",
    "longitude": "77.61",
    "confidenceScore": 1,
    "city": "BENGALURU",
    "state": "KARNATAKA",
    "stateCode": "KA",
    "country": "INDIA",
    "countryCode": "IN",
    "zipcode": "560076",
    "distanceInKms": ""
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!