Address Validation

Using the Address Validation API

4min

🚧 Address Validation V1﻿
This guide covers v1 of the Address Validation API. While this version remains functional, we recommend switching to v2, which offers improved features and functionality. Access to the v2 documentation is available here. You can also contact our support team for further information. 
Making a Request
To validate an address, make a POST request to the Address Validation endpoint with the address details in the request body.
Request body:
The request body should contain data object with the following fields:
Field
Required/Optional
Type
Description
address
Required
string
The street address which you want to process.
pincode
Optional
string
Pincode associated with the provided address.
city
Optional
string
City associated with the provided address.
state
Optional
string
State associated with the provided address.
Example Request:
JSON
{
  "data": {
    "address": "Plot 5, Sector 44, Gurgaon",
    "pincode": "122003",
    "city": "Gurgaon",
    "state": "Haryana"
  }
}
{
  "data": {
    "address": "Plot 5, Sector 44, Gurgaon",
    "pincode": "122003",
    "city": "Gurgaon",
    "state": "Haryana"
  }
}
﻿
Understanding the Response
The Address Validation API will return a JSON response with the validation status of the address.
Response Schema:
Field
Type
Description
success
boolean
Indicates if the request was successful. true if successful, false if there was an error.
status_code
number
Status code of the request.
message
string
Information about the processed request.
request_id
string
A unique id for the request.
result
object
Contains the validation status of the address.
result.address-validity
string
In the result object, you'll find the validation status of the address, which can be Valid, Ambiguous, Junk, or Incomplete.
result.address-quality_score
string
In the result object, you'll find the address quality score between 0 and 100(0→low, 100→high).
Example Response:
JSON
{
   "success": true,
   "status_code": 200,
   "message": "Request has been processed",
   "request_id": "geocode|1e547c85-4553-42b8-b268-be32411cfc00",
   "result": {
       "address-validity": "Valid",
       "address-quality-score": 79.25
  }
}
{
   "success": true,
   "status_code": 200,
   "message": "Request has been processed",
   "request_id": "geocode|1e547c85-4553-42b8-b268-be32411cfc00",
   "result": {
       "address-validity": "Valid",
       "address-quality-score": 79.25
  }
}
﻿
﻿
﻿
﻿

Field	Required/Optional	Type	Description
address	Required	string	The street address which you want to process.
pincode	Optional	string	Pincode associated with the provided address.
city	Optional	string	City associated with the provided address.
state	Optional	string	State associated with the provided address.

Field	Type	Description
success	boolean	Indicates if the request was successful. true if successful, false if there was an error.
status_code	number	Status code of the request.
message	string	Information about the processed request.
request_id	string	A unique id for the request.
result	object	Contains the validation status of the address.
result.address-validity	string	In the result object, you'll find the validation status of the address, which can be Valid, Ambiguous, Junk, or Incomplete.
result.address-quality_score	string	In the result object, you'll find the address quality score between 0 and 100(0→low, 100→high).

Address Validation