Countries

Get address format

GET/v1/meta/countries/{countryCode}/address-format

curl --request GET \
  --url https://api.serverside.com/v1/meta/countries/{countryCode}/address-format \
  --header 'X-API-KEY: <api-key>'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "country": "<string>",
    "regionLabel": "<string>",
    "regionRequired": true,
    "regions": [
      {
        "code": "<string>",
        "name": "<string>"
      }
    ],
    "postalCodeRegex": "<string>",
    "postalCodeExamples": [
      "<string>"
    ]
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-KEYstringheaderrequired
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Path parameters

countryCodestringrequired

Response

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject