Cleanse

vertex Address Validation Api Guest Cleanse Address V1Cleanse Address Post

Query Vertex to cleanse an address

post

/V1/guest-address/cleanse

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"cartId":"<string>","address":{"street_address":["<string>","<string>"],"city":"<string>","country":"<string>","main_division":"<string>","postal_code":"<string>","sub_division":"<string>"},"scopeCode":"<string>","scopeType":"<string>"}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/guest-address/cleanse' \
  --header 'Content-Type: application/json' \
  --data '{
    "cartId": "<string>",
    "address": {
      "street_address": [
        "<string>",
        "<string>"
      ],
      "city": "<string>",
      "country": "<string>",
      "main_division": "<string>",
      "postal_code": "<string>",
      "sub_division": "<string>"
    },
    "scopeCode": "<string>",
    "scopeType": "<string>"
  }'

200

400

500

200

{
  "street_address": [
    "eu amet ut",
    "veniam"
  ],
  "city": "magna consect",
  "country_code": "laborum labore anim",
  "country_name": "sint exercitation Lorem eiusmod",
  "postal_code": "Duis",
  "region_id": -48073813,
  "region_name": "nostrud officia",
  "sub_division": "eiusmod"
}

OK