API reference · Communities & institutions

Rental properties

GET/rental/propertyProperties you registered
POST/rental/propertyRegister a property
GET/rental/property/{reference}One property and its units
POST/rental/property/{reference}/unitAdd a unit to a property

GET Properties you registered

GET /rental/property

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListPropertyResponse

curl -X GET "https://api.bridgemoni.com/rental/property" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "titleReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "registryName": {
        "name": "string"
      },
      "registryCountryCode": "string",
      "registryRegion": {
        "name": "string"
      },
      "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "propertyType": "RESIDENTIAL",
      "landUse": "RESIDENTIAL",
      "certificateOfOccupancyNumber": "string",
      "certificateOfOccupancyIssueDate": "2026-09-25",
      "certificateOfOccupancyExpiryDate": "2026-09-25",
      "acquiredDate": "2026-09-25",
      "ownershipShare": {
        "rate": 0
      },
      "encumbered": "true",
      "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "lastCheckedDateTime": "2026-09-25T10:00:00Z",
      "active": "true",
      "certificateOfOccupancyCurrent": "true",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Properties retrieved successfully"
}

Responses

Status	When
`200`	Properties retrieved successfully

POST Register a property

POST /rental/property

An assertion, graded G0 until somebody verifies it. Registering an address that is already known in the market returns the existing property rather than a duplicate, so two occupants of one block share one building.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: PropertyRequest · Response: GenericResponsePropertyResponse

curl -X POST "https://api.bridgemoni.com/rental/property" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "marketCode": "NG-LA",
  "propertyType": "BLOCK_OF_FLATS",
  "displayName": "Adeola Court",
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressLine": "12 Adeola Odeku Street",
  "area": "Victoria Island",
  "city": "Lagos",
  "latitude": 0,
  "longitude": 0
}'

{
  "marketCode": "NG-LA",
  "propertyType": "BLOCK_OF_FLATS",
  "displayName": "Adeola Court",
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressLine": "12 Adeola Odeku Street",
  "area": "Victoria Island",
  "city": "Lagos",
  "latitude": 0,
  "longitude": 0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "titleReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "registryName": {
      "name": "string"
    },
    "registryCountryCode": "string",
    "registryRegion": {
      "name": "string"
    },
    "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyType": "RESIDENTIAL",
    "landUse": "RESIDENTIAL",
    "certificateOfOccupancyNumber": "string",
    "certificateOfOccupancyIssueDate": "2026-09-25",
    "certificateOfOccupancyExpiryDate": "2026-09-25",
    "acquiredDate": "2026-09-25",
    "ownershipShare": {
      "rate": 0
    },
    "encumbered": "true",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "certificateOfOccupancyCurrent": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Property registered successfully"
}

Responses

Status	When
`200`	Property registered successfully
`404`	No such market

GET One property and its units

GET /rental/property/{reference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponsePropertyResponse

curl -X GET "https://api.bridgemoni.com/rental/property/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",
    "titleReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "registryName": {
      "name": "string"
    },
    "registryCountryCode": "string",
    "registryRegion": {
      "name": "string"
    },
    "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyType": "RESIDENTIAL",
    "landUse": "RESIDENTIAL",
    "certificateOfOccupancyNumber": "string",
    "certificateOfOccupancyIssueDate": "2026-09-25",
    "certificateOfOccupancyExpiryDate": "2026-09-25",
    "acquiredDate": "2026-09-25",
    "ownershipShare": {
      "rate": 0
    },
    "encumbered": "true",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "certificateOfOccupancyCurrent": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Property retrieved successfully"
}

Responses

Status	When
`200`	Property retrieved successfully
`404`	No such property

POST Add a unit to a property

POST /rental/property/{reference}/unit

The unit is the lettable thing; tenancies, charges and listings attach to it. A label already on the property returns that unit.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: UnitRequest · Response: GenericResponseUnitResponse

curl -X POST "https://api.bridgemoni.com/rental/property/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/unit" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "unitLabel": "Block C Flat 4",
  "unitType": "SELF_CONTAINED",
  "bedrooms": 0,
  "bathrooms": 0,
  "furnished": true
}'

{
  "unitLabel": "Block C Flat 4",
  "unitType": "SELF_CONTAINED",
  "bedrooms": 0,
  "bathrooms": 0,
  "furnished": true
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitLabel": "string",
    "unitType": "SELF_CONTAINED",
    "bedrooms": 0,
    "bathrooms": 0,
    "furnished": true,
    "status": "VACANT",
    "currentTenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Unit added successfully"
}

Responses

Status	When
`200`	Unit added successfully
`404`	No such property

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors