LocateOne APIs

Validate Address

Last updated August 28, 2023

The Address Validation API provides a classification to each address that reflects its quality and checks for inconsistencies like mismatches between the state, city, and pin code.

POSThttps://api.getos1.com/locateone/v2/validate

Headers

x-api-keystringrequired

This key is used for authentication and billing.

Content-typestringrequired

application/json

Body

bodyobjectrequired

The request payload in JSON format.

dataobjectrequired

addressstringoptional

Example: D1-87 Aravali Heights, Dharuhera Bhiwadi Bypass

citystringoptional

Example: Dharuhera

statestringoptional

Example: Haryana

pincodestringoptional

Example: 122100

languagestringoptional

Example: English

Request example

curl --request POST \
     --url https://api.getos1.com/locateone/v2/validate \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: string' \
     --data '{
     "data": {}
     }'

Responses

200400401403429500

200Success

successbooleanoptional

Example: true

status_codeintegeroptional

Example: 200

messagestringoptional

Example: Request has been processed

request_idstringoptional

Example: addval|jsbvkjs

resultobjectoptional

address-validitystringrequired

Example: valid

address_typeobjectrequired

typestringoptional

Example: residential

sub_typestringoptional

Example: society

address_metadataobjectrequired

rooftop_confirmedbooleanoptional

Example: true

landmark_confirmedbooleanoptional

Example: false

is_ruralbooleanoptional

Example: false

state_confirmedbooleanoptional

Example: true

city_confirmedbooleanoptional

Example: true

pin_confirmedbooleanoptional

Example: true

pin_state_mismatchbooleanoptional

Example: false

pin_city_mismatchbooleanoptional

Example: false

multi_city_tokensbooleanoptional

Example: false

is_localizablebooleanoptional

Example: true

address_attributesobjectoptional

errorstringoptional

Example: null

400Bad request(missing or invalid data/type)

401Unauthorized

403Forbidden

429Too many requests

500Internal Server Error

Response samples

// Success
{
  "success": true,
  "status_code": 200,
  "message": "Request has been processed",
  "request_id": "addval|jsbvkjs",
  "result": {
    "address-validity": "valid",
    "address_type": {
      "type": "residential",
      "sub_type": "society"
    },
    "address_metadata": {
      "rooftop_confirmed": true,
      "landmark_confirmed": false,
      "is_rural": false,
      "state_confirmed": true,
      "city_confirmed": true,
      "pin_confirmed": true,
      "pin_state_mismatch": false,
      "pin_city_mismatch": false,
      "multi_city_tokens": false,
      "is_localizable": true
    },
    "address_attributes": {}
  },
  "error": "null"
}