Cleanse

vertex Address Validation Api Cleanse Address V1Cleanse Address Post

post

Query Vertex to cleanse an address

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

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

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /V1/address/cleanse HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 217

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

{
  "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"
}