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