What is Address Standardization?

The Address Standardization service takes a nonformatted address and breaks the address into identifiable components like country, state, city, locality, and sub locality along with additional information like street, landmark, floor, etc. It also identifies/corrects the address pin code.

API request format

Headers

• x-api-key

  • Description: This key is used for validation and quota management.
  • Example: xxxxxxxxxxxxxxxxxxxxxxxxxx

• Content-type

  • Description: The Content-Type header describes the format in which the body of your request is being sent as.
  • Supported value: Application/Json

Note: To get an API key, you can send a request to us at insights@delhivery.com.

Parameters

• data^{* (required)}
  • Description: Payload with details of address, pin code, city, and state.
  • Fields
    • address^{* (required)}
      • Description: The street address for which you want to get the standardized output.
      • Example: Plot 5, Sector 44, Gurgaon
    • pincode ^(Optional)
      • Description: Pincode associated with the provided address.
      • Example: 122003
    • city ^(Optional)
      • Description: City associated with the provided address.
      • Example: Gurgaon
    • state ^(Optional)
      • Description: State associated with the provided address.
      • Example: Haryana

{
    "data": {
      "address": "Plot 5, Sector 44, Gurgaon",
      "pincode": "122003",
      "city": "Gurgaon",
      "state": "Haryana"
    }
}

API responses

Response details

• success

  • Description: True value indicates that the address was successfully parsed and the response has been returned without any error. A false value would suggest an error in processing the request. The details for the possible reason for any error will be provided via the message key.
  • Possible values: True / False

• status_code

  • Description: Status codes indicate whether a specific API request has been successfully completed. And these codes will also help you track down the reason in case of failure.
  • Possible values: 200 / 400 / 401 / 403 / 429 / 500

• message

  • Description: This field will provide the information regarding the request processed by the Address Standardization service. This may help you get an idea about the success or a possible reason for failure.
  • Example: Request has been processed

• request_id

  • Description: unique id to distinguish between requests.
  • Example: AX34687667877689

• result: Contains the identifiable address components like country, state, city, locality, and sub locality along with additional information like street, landmark, floor, etc. It also has the identified/corrected pin code.

  • pincode

    • Description: Pincode identified from the address.
    • Example: 122003

  • country

    • Description: country associated with the provided address.
    • Example: india

  • state

    • Description: state associated with the provided address.
    • Example: haryana

  • city

    • Description: city associated with the provided address.
    • Example: gurgaon

  • locality

    • Description: locality associated with the provided address.
    • Example: sector 44

  • sub_locality

    • Description: sub locality associated with the provided address.
    • Example: delhivery corporate office

  • entity_information

    • Description: Additional information related to the provided address, like floor, street, plot number, wing number, room number, block, phase, etc. This will be in the form of key-value pairs with the available information.

    • Possible information: |

      {
        "pocket": "string",
        "villa": "string",
        "mile": "string",
        "floor": "string",
        "plot": "string",
        "room": "string",
        "house": "string",
        "quarter": "string",
        "door": "string",
        "sco": "string",
        "shop": "string",
        "sector": "string",
        "flat": "string",
        "cross road": "string",
        "main road": "string",
        "feet road": "string",
        "ps road": "string",
        "cross": "string",
        "main": "string",
        "cross street": "string",
        "main street": "string",
        "gali": "string",
        "hostel": "string",
        "tower": "string",
        "block": "string",
        "phase": "string",
        "street": "string",
        "road": "string",
        "stage": "string",
        "lane": "string",
        "building": "string",
        "survey": "string",
        "wing": "string",
        "avenue": "string",
        "gate": "string",
        "ward": "string",
        "landmark_name": ["string"],
        "company_name": ["string"],
        "building_name": "string",
        "society": "string",
        "unit": "string",
        "door_information": "string"
      }
      

    • Example entity_information: |

      {
        "plot": "5",
        "sector": "44",
        "door_information": "5"
      }
      

  • Example result: |

    {
          "pincode": 122003,
          "country": "india",
          "state": "Haryana",
          "city": "gurgaon",
          "locality": "sector - 44",
          "sub_locality": "delhivery corporate office",
          "entity_information": {
            "plot": "5",
            "sector": "44",
            "door_information": "5"
          }
    }
    

{
  "success": true,
  "status_code": 200,
  "message": "Request has been processed",
  "request_id": AX34687667877689,
  "result": {
    "pincode": 122003,
    "country": "india",
    "state": "haryana",
    "city": "gurgaon",
    "locality": "sector 44",
    "sub_locality": "delhivery corporate office",
    "entity_information": {
      "plot": "5",
      "sector": "44",
      "door_information": "5"
    }
  }
}