Using the Address Correlation API

making api request endpoint post /address correlation purpose this api is designed to allow clients to verify the correlation between an address and its corresponding mobile number to correlate an address, make a post request to the correlateaddress 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 , phone number , has consent , and consent text parameters 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 " sample request payload { "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" } receiving the api response after making the request, the api will return a response containing the following details parameter description example / possible values data provides details regarding the correlation of the address and phone number add found if the address has been independently found in the records boolean ph found if the ph no has been independently found in the records boolean add ph found if the combination of address and phone number is found in the records boolean 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 “relatedness message provides information about the success or failure of the request “success” sample response { "status code" 200, "message" "success", "request id" "relatedness|aef66d7a b09e 472f b2b2 aa8e9ad3971e", "data" { "add found" true, "ph found" true, "add ph found" true }, "error" null } handling the response in response, you can verify the address and phone number relationship using the add found , ph found , and add ph found fields the add found indicates if the address is present in our records, ph found shows if the phone number is listed, and add ph found reveals if the address and phone number are found together in our database