API reference · Communities & institutions

Rentals trust

GET/rental/complaint/against-meComplaints made against you
GET/rental/complaint/{reference}A complaint and its thread
POST/rental/complaint/{reference}/messageAdd to the thread
POST/rental/complaint/{reference}/outcomeConfirm or dispute the answer
POST/rental/complaint/{reference}/respondAnswer a complaint
POST/rental/complaint/{reference}/withdrawWithdraw a complaint
GET/rental/facts/meWhat the record says about you
POST/rental/me/erasureErase your rentals record
GET/rental/party/{reference}/factsFacts about a landlord or agent
GET/rental/party/{reference}/reviewsReviews of a landlord, or of yourself
GET/rental/property/{reference}/reviewsReviews of a property
POST/rental/review/{reference}/replyReply to a review about you
GET/rental/shareYour share links
POST/rental/shareShare your record
POST/rental/share/{reference}/revokeRevoke a share link
GET/rental/shared/{token}Read a record someone shared with you
POST/rental/tenancy/{reference}/complaintComplain about the landlord or agent
POST/rental/tenancy/{reference}/reviewReview from a tenancy

GET Complaints made against you

GET /rental/complaint/against-me

Headers

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

Example

Response: GenericResponseListComplaintResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "respondentRole": "OCCUPANT",
      "subject": "string",
      "status": "AWAITING_DELIVERY",
      "deliveredAt": "2026-09-25T10:00:00Z",
      "responseDueAt": "2026-09-25T10:00:00Z",
      "respondedAt": "2026-09-25T10:00:00Z",
      "confirmationDueAt": "2026-09-25T10:00:00Z",
      "closedAt": "2026-09-25T10:00:00Z",
      "thread": [
        {
          "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "body": "string",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    }
  ],
  "description": "Complaints retrieved successfully"
}

Responses

Status	When
`200`	Complaints retrieved successfully

GET A complaint and its thread

GET /rental/complaint/{reference}

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseComplaintResponse

curl -X GET "https://api.bridgemoni.com/rental/complaint/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",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Complaint retrieved successfully"
}

Responses

Status	When
`200`	Complaint retrieved successfully

POST Add to the thread

POST /rental/complaint/{reference}/message

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: ComplaintMessageRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/rental/complaint/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/message" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

{
  "body": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Message added successfully"
}

Responses

Status	When
`200`	Message added successfully

POST Confirm or dispute the answer

POST /rental/complaint/{reference}/outcome

Silence closes the complaint as withdrawn, not unresolved; unresolved is reserved for a respondent who never answered.

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: ComplaintOutcomeRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/rental/complaint/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/outcome" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "resolved": true
}'

{
  "resolved": true
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Outcome recorded successfully"
}

Responses

Status	When
`200`	Outcome recorded successfully

POST Answer a complaint

POST /rental/complaint/{reference}/respond

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: ComplaintMessageRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/rental/complaint/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/respond" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

{
  "body": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Response recorded successfully"
}

Responses

Status	When
`200`	Response recorded successfully

POST Withdraw a complaint

POST /rental/complaint/{reference}/withdraw

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/rental/complaint/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/withdraw" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Complaint withdrawn successfully"
}

Responses

Status	When
`200`	Complaint withdrawn successfully

GET What the record says about you

GET /rental/facts/me

Computed on read from what the platform itself observed, each with the number of observations behind it. Every disclosure is logged.

Headers

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

Example

Response: GenericResponseListPartyFactsResponse

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

{
  "data": [
    {
      "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "partyType": "OCCUPANT",
      "erased": true,
      "asOf": "2026-09-25T10:00:00Z",
      "facts": [
        {
          "key": "rental.on_time_rate_24m",
          "value": 0,
          "unit": "RATIO",
          "observations": 0,
          "windowStart": "2026-09-25",
          "windowEnd": "2026-09-25"
        }
      ]
    }
  ],
  "description": "Facts retrieved successfully"
}

Responses

Status	When
`200`	Facts retrieved successfully

POST Erase your rentals record

POST /rental/me/erasure

Pseudonymises your parties, deletes your free text and the documents you uploaded, and stops every fact about you being computed. Ledger postings are kept, as the law requires. Refused while a tenancy or money is still live.

Headers

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

Example

Response: GenericResponseErasureResponse

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

{
  "data": {
    "partyReferences": [
      "string"
    ],
    "erasedAt": "2026-09-25T10:00:00Z",
    "reviewsErased": 0,
    "documentsDetached": 0
  },
  "description": "Record erased successfully"
}

Responses

Status	When
`200`	Record erased successfully
`409`	A tenancy or money is still live

GET Facts about a landlord or agent

GET /rental/party/{reference}/facts

Landlords and agents are public. An occupant's facts are never answered to a query; the occupant shares them with a link.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponsePartyFactsResponse

curl -X GET "https://api.bridgemoni.com/rental/party/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/facts" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "partyType": "OCCUPANT",
    "erased": true,
    "asOf": "2026-09-25T10:00:00Z",
    "facts": [
      {
        "key": "rental.on_time_rate_24m",
        "value": 0,
        "unit": "RATIO",
        "observations": 0,
        "windowStart": "2026-09-25",
        "windowEnd": "2026-09-25"
      }
    ]
  },
  "description": "Facts retrieved successfully"
}

Responses

Status	When
`200`	Facts retrieved successfully
`404`	No such party, or an occupant who has not shared

GET Reviews of a landlord, or of yourself

GET /rental/party/{reference}/reviews

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListReviewResponse

curl -X GET "https://api.bridgemoni.com/rental/party/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/reviews" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "target": "PROPERTY",
      "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "rating": 0,
      "body": "string",
      "status": "PUBLISHED",
      "reply": "string",
      "repliedAt": "2026-09-25T10:00:00Z",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Reviews retrieved successfully"
}

Responses

Status	When
`200`	Reviews retrieved successfully

GET Reviews of a property

GET /rental/property/{reference}/reviews

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListReviewResponse

curl -X GET "https://api.bridgemoni.com/rental/property/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/reviews" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "target": "PROPERTY",
      "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "rating": 0,
      "body": "string",
      "status": "PUBLISHED",
      "reply": "string",
      "repliedAt": "2026-09-25T10:00:00Z",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Reviews retrieved successfully"
}

Responses

Status	When
`200`	Reviews retrieved successfully

POST Reply to a review about you

POST /rental/review/{reference}/reply

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: ReviewReplyRequest · Response: GenericResponseReviewResponse

curl -X POST "https://api.bridgemoni.com/rental/review/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/reply" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

{
  "body": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "target": "PROPERTY",
    "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rating": 0,
    "body": "string",
    "status": "PUBLISHED",
    "reply": "string",
    "repliedAt": "2026-09-25T10:00:00Z",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Reply saved successfully"
}

Responses

Status	When
`200`	Reply saved successfully

GET Your share links

GET /rental/share

Headers

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

Example

Response: GenericResponseListShareLinkResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "token": "string",
      "purpose": "string",
      "expiresAt": "2026-09-25T10:00:00Z",
      "revokedAt": "2026-09-25T10:00:00Z",
      "timesRead": 0
    }
  ],
  "description": "Share links retrieved successfully"
}

Responses

Status	When
`200`	Share links retrieved successfully

POST Share your record

POST /rental/share

Creates a link that shows your facts and the reviews landlords wrote about you, until it expires or you revoke it. The token is shown once.

Headers

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

Example

Request body: ShareLinkRequest · Response: GenericResponseShareLinkResponse

curl -X POST "https://api.bridgemoni.com/rental/share" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "purpose": "Application for Flat 3, Adeola Gardens",
  "validDays": 14
}'

{
  "purpose": "Application for Flat 3, Adeola Gardens",
  "validDays": 14
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "token": "string",
    "purpose": "string",
    "expiresAt": "2026-09-25T10:00:00Z",
    "revokedAt": "2026-09-25T10:00:00Z",
    "timesRead": 0
  },
  "description": "Share link created successfully"
}

Responses

Status	When
`200`	Share link created successfully

POST Revoke a share link

POST /rental/share/{reference}/revoke

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseShareLinkResponse

curl -X POST "https://api.bridgemoni.com/rental/share/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/revoke" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "token": "string",
    "purpose": "string",
    "expiresAt": "2026-09-25T10:00:00Z",
    "revokedAt": "2026-09-25T10:00:00Z",
    "timesRead": 0
  },
  "description": "Share link revoked successfully"
}

Responses

Status	When
`200`	Share link revoked successfully

GET Read a record someone shared with you

GET /rental/shared/{token}

Headers

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

Path parameters

Name
`token`

Example

Response: GenericResponseSharedRecordResponse

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

{
  "data": {
    "facts": {
      "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "partyType": "OCCUPANT",
      "erased": true,
      "asOf": "2026-09-25T10:00:00Z",
      "facts": [
        {
          "key": "rental.on_time_rate_24m",
          "value": 0,
          "unit": "RATIO",
          "observations": 0,
          "windowStart": "2026-09-25",
          "windowEnd": "2026-09-25"
        }
      ]
    },
    "reviews": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "target": "PROPERTY",
        "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "rating": 0,
        "body": "string",
        "status": "PUBLISHED",
        "reply": "string",
        "repliedAt": "2026-09-25T10:00:00Z",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Shared record retrieved successfully"
}

Responses

Status	When
`200`	Shared record retrieved successfully
`404`	Expired, revoked or never existed

POST Complain about the landlord or agent

POST /rental/tenancy/{reference}/complaint

The respondent's clock starts at the first confirmed delivery, when they open it, never at the moment it is raised. A notification the platform failed to send does not count against them.

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: ComplaintRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/complaint" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "respondentRole": "OCCUPANT",
  "subject": "Water heater unrepaired for six weeks",
  "body": "string"
}'

{
  "respondentRole": "OCCUPANT",
  "subject": "Water heater unrepaired for six weeks",
  "body": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Complaint raised successfully"
}

Responses

Status	When
`200`	Complaint raised successfully

POST Review from a tenancy

POST /rental/tenancy/{reference}/review

After at least 90 days of an active tenancy. Reviews of a property or landlord are public; a review of an occupant is never published and is shown only through the occupant's own share link.

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: ReviewRequest · Response: GenericResponseReviewResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/review" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "PROPERTY",
  "rating": 4,
  "body": "Repairs were handled within a week"
}'

{
  "target": "PROPERTY",
  "rating": 4,
  "body": "Repairs were handled within a week"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "target": "PROPERTY",
    "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rating": 0,
    "body": "string",
    "status": "PUBLISHED",
    "reply": "string",
    "repliedAt": "2026-09-25T10:00:00Z",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Review written successfully"
}

Responses

Status	When
`200`	Review written successfully

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