Using the Address Confirmation API

sign up for the sign up for the address confirmation address confirmation api api connect with our sales team to sign up for the address confirmation api making a request to confirm an address, make a post request to the confirmaddress endpoint with the address details in the request body before making a request to the address correlation api, ensure you have all the required parameters ready address , has consent , and consent text request body parameter description type example pincode the pincode of the address string “673593” address the detailed address to be geocoded string “yogi complex g wing room no 103 1st floor” city the city of the address string “gurugram” state the state of the address string “kerala” phone number the contact phone number string “9999999999” has consent signifies explicit customer approval for sharing their data with the api and using the resulting outputs consent must be informed and specific to these uses boolean true consent text contains the specific excerpt from the terms & conditions or privacy policy where the customer's consent is requested this text should clearly detail the consent sought from the end customer string (up to 2048 characters) example request { "address" "100, hill rd, ranwar, bandra west", "phone number" "9999999999", "has consent" true, "consent text" "you also unconditionally authorize us to share your details with third parties/partners, including but not limited to logistics services partners for the purpose of validating your address against your phone number ", "city" "mumbai", "pincode" "4000001", "state" "maharashtra" } understanding the response the address confirmation api will return a json response with the confirmation status response schema parameter description example / possible values data provides an array with details regarding the last visited date visited before indicates whether the address has been visited by a field executive true/false last visited date specifies the date of the last visit date in string or empty string error contains details of any errors that occurred {"message" "invalid query parameters provided in input","type" “value error"} status code the status code of the response 200 request id a unique identifier for the request “liveness|aef66d7a b09e 472f b2b2 aa8e9ad3971e” message provides information about the success or failure of the request { "status code" 200, "message" "success", "request id" "liveness|aef66d7a b09e 472f b2b2 aa8e9ad3971e", "data" { "visited before" false, "last visited date" "" }, "error" null }