Using the Address Confirmation API

Learn how to confirm an address using the Address Confirmation endpoint by making a POST request. Include essential parameters like pincode, address, city, state, and phone number in the request body. Get a detailed JSON object response with information a

Sign up for the** Address Confirmation **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
}