Create a user and validate an address

POST /v2/fulfillment/lastmile/validate_address

Deprecated

This endpoint has been replaced by Create a Connect user and validate an address. The URI has changed and now includes the user ID as a path parameter instead of as a body parameter. Otherwise, the request parameters and responses remain the same. This change reflects our commitment to making our API more intuitive to use when implementing multiple fulfillment workflows in your ecommerce site. The deprecated endpoint is still supported for existing implementations. For new implementations, use the revised endpoint.

Creates a Connect user account and validates the address provided in the request. The user ID is generated by your site and can be any unique identifier, such as a login name, loyalty ID, or email address. For more information about users, see Create a user.

If a user account with the given user_id already exists, the address is validated and associated with the existing user. The response contains the existing user's ID and the validated street address and postal code.

When you create an order with this user_id, ensure that you use the validated address.

tip

Alternatively, you can create a user and validate an address as separate calls.

Security

Name	In	Description
Authorization	header	The Authorization header with the bearer token acquired during authentication.

Parameters

None.

Request

Field	Type	Required	Description
address_line_1	string		The first address line.
address_line_2	string		The second address line.
address_type	string		The type of address, e.g., "residential".
postal_code	string		The postal/zip code of the address.
user_id	string		Unique user ID to use for this user.

Request examples

cURL

curl --request POST \
  --url https://connect.instacart.com/v2/fulfillment/lastmile/validate_address \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "address_line_1": "string",
  "address_line_2": "string",
  "address_type": "string",
  "postal_code": "string",
  "user_id": "string"
}'

Java

HttpResponse<String> response = Unirest.post("https://connect.instacart.com/v2/fulfillment/lastmile/validate_address")
  .header("Accept", "application/json")
  .header("Content-Type", "application/json")
  .header("Authorization", "Bearer <token>")
  .body("{\n  \"address_line_1\": \"string\",\n  \"address_line_2\": \"string\",\n  \"address_type\": \"string\",\n  \"postal_code\": \"string\",\n  \"user_id\": \"string\"\n}")
  .asString();

Python

import http.client

conn = http.client.HTTPSConnection("connect.instacart.com")

payload = "{\n  \"address_line_1\": \"string\",\n  \"address_line_2\": \"string\",\n  \"address_type\": \"string\",\n  \"postal_code\": \"string\",\n  \"user_id\": \"string\"\n}"

headers = {
    'Accept': "application/json",
    'Content-Type': "application/json",
    'Authorization': "Bearer <token>"
    }

conn.request("POST", "/v2/fulfillment/lastmile/validate_address", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://connect.instacart.com/v2/fulfillment/lastmile/validate_address"

	payload := strings.NewReader("{\n  \"address_line_1\": \"string\",\n  \"address_line_2\": \"string\",\n  \"address_type\": \"string\",\n  \"postal_code\": \"string\",\n  \"user_id\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

Field	Type	Required	Description
address	CreateAddress		The address used for validation.
user_id	string		The ID of the user.

CreateAddress Object

Field	Type	Required	Description
address_line_1	string		The first address line.
postal_code	string		The postal/zip code of the address.
flags	Flags		Additional properties of the address.

Flags Object

Field	Type	Required	Description
long_distance_delivery	boolean		Whether a delivery to the address will be a long distance delivery.

Response examples

200 Success

200 Address created

{
  "address": {
    "address_line_1": "499 Gainsville",
    "postal_code": "81910"
  },
  "user_id": "roberteospeedwagon"
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP Code	Cause	Error Message	Error Code	Error Meta
400	Invalid input*	"There were issues with your request"	9999	Not applicable
400	Address not serviceable	"Address is not serviceable."	1001	{"key":"address_line_1"}
400	Without address line 1	"can't be blank"	1001	{"key":"address_line_1"}
400	Invalid address	"invalid_address"	1001	{"key":"address"}
400	Address contains PO box	"address contains PO Box"	1001	{"key":"address"}

* Multiple error