Skip to main content
POST
/
api
/
v2.1
/
fincard
/
virtual
/
common
/
v2
/
city
City List v2 (hierarchical)
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/common/v2/city \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --data '
{
  "regionCode": "AU"
}
'
{
  "success": true,
  "code": 123,
  "msg": "<string>",
  "data": [
    {
      "code": "<string>",
      "name": "<string>",
      "country": "<string>",
      "countryStandardCode": "<string>",
      "parentCode": "<string>",
      "children": [
        {
          "code": "<string>",
          "name": "<string>",
          "country": "<string>"
        }
      ]
    }
  ]
}

Headers

User-Agent
string

User agent

X-Forwarded-For
string

Forwarded for

X-Forwarded-From
string
required

Client application identifier

Example:

"client-app"

X-Tenant-ID
string

Tenant ID

deviceId
string

Device ID

platform
string

Platform

Body

application/json

City request with region code

City list request

regionCode
string

Country/Region code ISO 3166-1 alpha-2

Example:

"AU"

Response

Successful response

Hierarchical city response

success
boolean

Success flag

code
integer<int32>

Response code

msg
string

Response message

data
object[]

Hierarchical city data