Geocoding
curl --request POST \
--url https://sandbox.cashfree.com/verification/geocoding \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"verification_id": "test_verification_id",
"address": "123 ABC Apartment,Bangalore Karnataka - 560034",
"country_code": "IN",
"latitude": "12.9274477",
"longitude": "77.6326542"
}
'import requests
url = "https://sandbox.cashfree.com/verification/geocoding"
payload = {
"verification_id": "test_verification_id",
"address": "123 ABC Apartment,Bangalore Karnataka - 560034",
"country_code": "IN",
"latitude": "12.9274477",
"longitude": "77.6326542"
}
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
verification_id: 'test_verification_id',
address: '123 ABC Apartment,Bangalore Karnataka - 560034',
country_code: 'IN',
latitude: '12.9274477',
longitude: '77.6326542'
})
};
fetch('https://sandbox.cashfree.com/verification/geocoding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/verification/geocoding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'verification_id' => 'test_verification_id',
'address' => '123 ABC Apartment,Bangalore Karnataka - 560034',
'country_code' => 'IN',
'latitude' => '12.9274477',
'longitude' => '77.6326542'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/verification/geocoding"
payload := strings.NewReader("{\n \"verification_id\": \"test_verification_id\",\n \"address\": \"123 ABC Apartment,Bangalore Karnataka - 560034\",\n \"country_code\": \"IN\",\n \"latitude\": \"12.9274477\",\n \"longitude\": \"77.6326542\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/geocoding")
.header("x-api-version", "<x-api-version>")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"verification_id\": \"test_verification_id\",\n \"address\": \"123 ABC Apartment,Bangalore Karnataka - 560034\",\n \"country_code\": \"IN\",\n \"latitude\": \"12.9274477\",\n \"longitude\": \"77.6326542\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/verification/geocoding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"verification_id\": \"test_verification_id\",\n \"address\": \"123 ABC Apartment,Bangalore Karnataka - 560034\",\n \"country_code\": \"IN\",\n \"latitude\": \"12.9274477\",\n \"longitude\": \"77.6326542\"\n}"
response = http.request(request)
puts response.read_body{
"reference_id": 123456,
"verification_id": "testVerificationId",
"address": "123 Main Street, Koramangala, Bangalore",
"status": "VALID",
"latitude": "37.7749",
"longitude": "-122.4194",
"geo_latitude": "37.7749",
"geo_longitude": "-122.4194",
"geo_country_code": "IN",
"city": "Bangalore",
"state": "Karnataka",
"state_code": "KA",
"country": "India",
"country_code": "IN",
"pincode": "560034",
"distance_in_kms": "0.5"
}Geocoding
Geocoding
Use this API to convert a physical address into geographic coordinates (latitude and longitude). This helps verify location accuracy, enable map integrations, calculate distances, and support location-based services.
View the test data and use the information to trigger the validations. The test data can be used only in the sandbox environment.
POST
/
geocoding
Geocoding
curl --request POST \
--url https://sandbox.cashfree.com/verification/geocoding \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"verification_id": "test_verification_id",
"address": "123 ABC Apartment,Bangalore Karnataka - 560034",
"country_code": "IN",
"latitude": "12.9274477",
"longitude": "77.6326542"
}
'import requests
url = "https://sandbox.cashfree.com/verification/geocoding"
payload = {
"verification_id": "test_verification_id",
"address": "123 ABC Apartment,Bangalore Karnataka - 560034",
"country_code": "IN",
"latitude": "12.9274477",
"longitude": "77.6326542"
}
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
verification_id: 'test_verification_id',
address: '123 ABC Apartment,Bangalore Karnataka - 560034',
country_code: 'IN',
latitude: '12.9274477',
longitude: '77.6326542'
})
};
fetch('https://sandbox.cashfree.com/verification/geocoding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/verification/geocoding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'verification_id' => 'test_verification_id',
'address' => '123 ABC Apartment,Bangalore Karnataka - 560034',
'country_code' => 'IN',
'latitude' => '12.9274477',
'longitude' => '77.6326542'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/verification/geocoding"
payload := strings.NewReader("{\n \"verification_id\": \"test_verification_id\",\n \"address\": \"123 ABC Apartment,Bangalore Karnataka - 560034\",\n \"country_code\": \"IN\",\n \"latitude\": \"12.9274477\",\n \"longitude\": \"77.6326542\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/geocoding")
.header("x-api-version", "<x-api-version>")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"verification_id\": \"test_verification_id\",\n \"address\": \"123 ABC Apartment,Bangalore Karnataka - 560034\",\n \"country_code\": \"IN\",\n \"latitude\": \"12.9274477\",\n \"longitude\": \"77.6326542\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/verification/geocoding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"verification_id\": \"test_verification_id\",\n \"address\": \"123 ABC Apartment,Bangalore Karnataka - 560034\",\n \"country_code\": \"IN\",\n \"latitude\": \"12.9274477\",\n \"longitude\": \"77.6326542\"\n}"
response = http.request(request)
puts response.read_body{
"reference_id": 123456,
"verification_id": "testVerificationId",
"address": "123 Main Street, Koramangala, Bangalore",
"status": "VALID",
"latitude": "37.7749",
"longitude": "-122.4194",
"geo_latitude": "37.7749",
"geo_longitude": "-122.4194",
"geo_country_code": "IN",
"city": "Bangalore",
"state": "Karnataka",
"state_code": "KA",
"country": "India",
"country_code": "IN",
"pincode": "560034",
"distance_in_kms": "0.5"
}Authorizations
Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.
The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD.
Example:
"2024-12-01"
Body
application/json
Find the request parameters to Access Token Generation.
It displays the unique ID you created to identify the verification request.
Example:
"test_verification_id"
The full address for which coordinates are needed.
Example:
"123 ABC Apartment,Bangalore Karnataka - 560034"
It is the country code used for more accurate latitude and longitude results.
Example:
"IN"
Latitude to calculate distance from.
Example:
"12.9274477"
Longitude to calculate distance from.
Example:
"77.6326542"
Response
Response for geocoding API.
It displays the unique ID created by Cashfree for reference purposes.
format: int64
Example:
123456
It displays the unique ID you created to identify the verification request.
Example:
"testVerificationId"
The complete address, including location details, which was provided in the request.
Example:
"123 Main Street, Koramangala, Bangalore"
It displays the status of the address provided (VALID/INVALID).
Example:
"VALID"
The latitude value provided in request.
Example:
"37.7749"
The longitude value provided in request.
Example:
"-122.4194"
The actual latitude coordinate of the address from the source.
Example:
"37.7749"
The actual longitude coordinate of the address from the source.
Example:
"-122.4194"
The country code of the address.
Example:
"IN"
The city name of the address.
Example:
"Bangalore"
The state name of the address.
Example:
"Karnataka"
The state code of the address.
Example:
"KA"
The country name of the address.
Example:
"India"
The country code of the address.
Example:
"IN"
Pincode or ZIP code of the address.
Example:
"560034"
Distance in kilometers from the latitude and longitude provided in the input request body to actual location.
Example:
"0.5"
Was this page helpful?