POST /confirm-move-eligibility

This endpoint is used to determine whether the provided coordinates for a pickup or delivery location fall within an active Hopdrive service region. It accepts latitude and longitude coordinates for both pickup and delivery locations and checks if either or both locations are within a designated service area.

Example Request

POST /v1/confirm-move-eligibility

{
  "pickup_location" : {
    "name": "The White House",
    "address_one": "1600 Pennsylvania Ave NW",
    "city": "Washington",
    "state": "DC",
    "zip": "20500",
    "latitude": 38.8977,
    "longitude": -77.0365
  },
  "delivery_location" : {
    "name": "The Capitol",
    "address_one": "East Capitol St NE & First St SE",
    "city": "Washington",
    "state": "DC",
    "zip": "20004",
    "latitude": 38.8899,
    "longitude": -77.0091
  }
}

Body Params

Field	Type	Required?	Description
latitude	Number	Required	Latitude associated with the pickup or delivery location.
longitude	Number	Required	Longitude associated with the pickup or delivery location.
name	String	Optional	Name associated with the location.
full_address	String	Optional	The full address string of the location (Address pieces are no longer required if this field has a value).
address_one	String	Optional	The street address of the location.
address_two	String	Optional	Optional sub-address of the location.
city	String	Optional	The city that the location address is associated with.
state	String	Optional	The state that the location address is associated with.
zip	String	Optional	The 5-digit Zip Code that the location address is associated with.

Request Object Structure

{
  pickup_location : {
    name, //optional
    address_one, //optional
    address_two, //optional
    city, //optional
    state, //optional
    zip, //optional
    latitude,
    longitude
  },
  delivery_location : {
    name, //optional
    address_one, //optional
    address_two, //optional
    city, //optional
    state, //optional
    zip, //optional
    latitude,
    longitude
  }
}

Example Response

For additional information, see the response section.

200 /v1/confirm-move-eligibility

{
  "is_within_supported_region": true,
  "pickup_location": {
    "name": "The White House",
    "address_one": "1600 Pennsylvania Ave NW",
    "city": "Washington",
    "state": "DC",
    "zip": "20500",
    "latitude": 38.8977,
    "longitude": -77.0365,
    "is_within_supported_region": true
  },
  "delivery_location": {
    "name": "The Capitol",
    "address_one": "East Capitol St NE & First St SE",
    "city": "Washington",
    "state": "DC",
    "zip": "20004",
    "latitude": 38.8899,
    "longitude": -77.0091,
    "is_within_supported_region": true
  }
}