Cleanse

vertex Address Validation Api Cleanse Address V1Cleanse Address Post

Query Vertex to cleanse an address

post

/V1/address/cleanse

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

500

200

{
  "street_address": [
    "culpa",
    "in consectetur deseru"
  ],
  "city": "in pariatur",
  "country_code": "amet commodo",
  "country_name": "eiusmod laboris elit esse",
  "postal_code": "mollit par",
  "region_id": 90831712,
  "region_name": "nostrud nisi enim velit",
  "sub_division": "sit culpa irure amet"
}

OK