Get Region List (USER_DATA)

API Description

Query the active region/city list for a given country. Currently, only supports AU entity.

HTTP Request

GET /sapi/v1/localentity/region/list

Request Weight(IP)

1

Request Parameters

Name	Type	Mandatory	Description
countryCode	STRING	YES	ISO 2-digit country code (from Country List API).
timestamp	LONG	YES

Response Example

{
    "countryCode": "au",
    "regions": [
        {
            "regionName": "New South Wales",
            "blockType": "supported",
            "depositAllowed": true,
            "withdrawalAllowed": true
        }
    ],
    "lastUpdated": 1716300000000
}

Response Fields

Name	Type	Description
countryCode	STRING	Echoed country code (lowercase).
regions	ARRAY	List of active regions for the given country.
regions[].regionName	STRING	Region/city display name (use this value in questionnaire answers).
regions[].blockType	STRING	supported, limited, or blocked.
regions[].depositAllowed	BOOLEAN	Whether deposit is allowed for this region.
regions[].withdrawalAllowed	BOOLEAN	Whether withdrawal is allowed for this region.
lastUpdated	LONG	Last data update timestamp (epoch milliseconds); 0 if empty.