Address Validation
Using the Address Validation API
4min
🚧 address validation v1 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 { "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 { "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 } }