Skip to content

Address Formatter

Get country-specific address formatting rules. Returns the address format template for a given country code.

Endpoint: POST /biz/cloud/digital/std/address/formatter

Parameters

ParameterTypeRequiredDescription
countryCodeStringYesISO 3166-1 alpha-2 country code

Request

bash
curl -X POST "https://api.alaikis.com/std/biz/cloud/digital/std/address/formatter" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d 'bizContent={"countryCode": "JP"}'

Response

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "countryCode": "JP",
    "format": "〒{postalCode}\n{region}{city}{street}",
    "fields": ["postalCode", "region", "city", "street"],
    "example": "〒100-0001\n東京都千代田区千代田1-1"
  }
}

Supported Countries

Supports 190+ countries with address formatting rules based on Universal Postal Union (UPU) standards.

Error Codes

CodeDescription
400Invalid JSON format
406Missing required parameter (countryCode)