API reference · Identity & onboarding
Regions
GET Fetch a region by code, scoped to a country
GET /region/code/{code}
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Query parameters
| Name | Default |
|---|
countryReference | Optional |
Example
Response: RegionResponse
curl -X GET "https://api.bridgemoni.com/region/code/BRG-001?countryReference=value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"name": "Ada Obi",
"code": "country subdivision code",
"countryReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"creationDateTime": "2027-03-14T14:30:01"
},
"description": "Fetch a region by code, scoped to a country"
}
Responses
| Status | When |
|---|
200 | Region fetched successfully |
404 | No region exists for the given code under this country |
GET Fetch a region by reference
GET /region/{id}
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: RegionResponse
curl -X GET "https://api.bridgemoni.com/region/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"name": "Ada Obi",
"code": "country subdivision code",
"countryReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"creationDateTime": "2027-03-14T14:30:01"
},
"description": "Fetch a region by reference"
}
Responses
| Status | When |
|---|
200 | Region fetched successfully |
404 | No region exists for the given reference |
GET List regions under a country
GET /regions
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Query parameters
| Name | Default |
|---|
countryReference | Optional |
Example
Response: List<RegionResponse>
curl -X GET "https://api.bridgemoni.com/regions?countryReference=value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"name": "Ada Obi",
"code": "country subdivision code",
"countryReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"creationDateTime": "2027-03-14T14:30:01"
}
],
"description": "List regions under a country"
}
Responses
| Status | When |
|---|
200 | Regions fetched successfully |
Bridge