API reference · Communities & institutions

Rentals agents

GET/rental/agent/claimsYour listing claims, including expired and superseded ones
GET/rental/agent/earningsYour earnings
POST/rental/agent/enrolEnrol as an agent
GET/rental/agent/profileYour agent profile
POST/rental/agent/unit/{reference}/claimAssert exclusivity over a unit
POST/rental/landlord/tenancy/{reference}/renewalPropose renewal terms
POST/rental/landlord/unit/{reference}/delistRemove an agent's exclusivity over your unit
POST/rental/landlord/unit/{reference}/grantGrant a listing to an agent
POST/rental/tenancy/{reference}/renewal/acceptAccept the proposed renewal
POST/rental/tenancy/{reference}/renewal/declineDecline the proposed renewal

GET Your listing claims, including expired and superseded ones

GET /rental/agent/claims

Headers

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

Example

Response: GenericResponseListListingClaimResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "agentPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "basis": "FIRST_VERIFIED_LISTER",
      "status": "ACTIVE",
      "grantedAt": "2026-09-25T10:00:00Z",
      "expiresAt": "2026-09-25T10:00:00Z",
      "supersededReason": "string"
    }
  ],
  "description": "Listing claims retrieved successfully"
}

Responses

Status	When
`200`	Listing claims retrieved successfully

GET Your earnings

GET /rental/agent/earnings

Derived from settled obligations every time it is read. There is no stored total to drift from the postings that produced it.

Headers

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

Example

Response: GenericResponseAgentEarningsResponse

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

{
  "data": {
    "trailSettled": 0,
    "placementSettled": 0,
    "pending": 0,
    "heldBack": 0,
    "nettedAgainst": 0,
    "placementsActive": 0,
    "entitlements": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "basis": "PERCENT_OF_RENT_PAYMENT",
        "rate": 0,
        "fixedAmount": 0,
        "effectiveFrom": "2026-09-25",
        "effectiveTo": "2026-09-25",
        "survivesDelisting": true,
        "holdbackPercent": 0,
        "holdbackTrigger": "FIRST_RENEWAL",
        "status": "ACTIVE"
      }
    ]
  },
  "description": "Earnings retrieved successfully"
}

Responses

Status	When
`200`	Earnings retrieved successfully

POST Enrol as an agent

POST /rental/agent/enrol

With an identity document and a guarantor. An enrolled agent can claim listings only after an operator verifies them.

Headers

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

Example

Request body: AgentEnrolmentRequest · Response: GenericResponseAgentProfileResponse

curl -X POST "https://api.bridgemoni.com/rental/agent/enrol" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Bright Homes Realty",
  "identityDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "photoDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "guarantorName": "Mrs Folake Adewale",
  "guarantorMsisdn": "2348031112222",
  "guarantorRelationship": "Former employer"
}'

{
  "displayName": "Bright Homes Realty",
  "identityDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "photoDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "guarantorName": "Mrs Folake Adewale",
  "guarantorMsisdn": "2348031112222",
  "guarantorRelationship": "Former employer"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "party": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "partyType": "OCCUPANT",
      "claimStatus": "UNCLAIMED",
      "status": "ACTIVE",
      "verificationGrade": "G0_ASSERTED",
      "displayName": "string",
      "invitationExpiresAt": "2026-09-25T10:00:00Z",
      "invitationCode": "string"
    },
    "status": "PENDING_VERIFICATION",
    "guarantorName": "string",
    "enrolledAt": "2026-09-25T10:00:00Z"
  },
  "description": "Agent enrolled successfully"
}

Responses

Status	When
`200`	Agent enrolled successfully

GET Your agent profile

GET /rental/agent/profile

Headers

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

Example

Response: GenericResponseAgentProfileResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "party": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "partyType": "OCCUPANT",
      "claimStatus": "UNCLAIMED",
      "status": "ACTIVE",
      "verificationGrade": "G0_ASSERTED",
      "displayName": "string",
      "invitationExpiresAt": "2026-09-25T10:00:00Z",
      "invitationCode": "string"
    },
    "status": "PENDING_VERIFICATION",
    "guarantorName": "string",
    "enrolledAt": "2026-09-25T10:00:00Z"
  },
  "description": "Agent profile retrieved successfully"
}

Responses

Status	When
`200`	Agent profile retrieved successfully

POST Assert exclusivity over a unit

POST /rental/agent/unit/{reference}/claim

Only over a property whose ownership has been verified, and only until it expires. Activity renews it; nothing else does. The landlord's own verified ownership always wins.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListingClaimResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "agentPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "basis": "FIRST_VERIFIED_LISTER",
    "status": "ACTIVE",
    "grantedAt": "2026-09-25T10:00:00Z",
    "expiresAt": "2026-09-25T10:00:00Z",
    "supersededReason": "string"
  },
  "description": "Listing claimed successfully"
}

Responses

Status	When
`200`	Listing claimed successfully
`409`	Not verified, ownership unverified, or held by another agent

POST Propose renewal terms

POST /rental/landlord/tenancy/{reference}/renewal

The renewal continues the same tenancy chain: the agent's trail, the record and the deposit carry on. It takes effect when the occupant accepts.

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: RenewalProposalRequest · Response: GenericResponseRenewalProposalResponse

curl -X POST "https://api.bridgemoni.com/rental/landlord/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/renewal" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "rentAmount": 0,
  "expiryDate": "2026-09-25",
  "narrative": "string"
}'

{
  "rentAmount": 0,
  "expiryDate": "2026-09-25",
  "narrative": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rentAmount": 0,
    "commencementDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "status": "PROPOSED",
    "termsVersion": 0,
    "decidedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Renewal proposed successfully"
}

Responses

Status	When
`200`	Renewal proposed successfully

POST Remove an agent's exclusivity over your unit

POST /rental/landlord/unit/{reference}/delist

Immediate and without appeal for the verified owner. An agent's trail on tenancies they already placed survives; only their exclusivity ends.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListingClaimResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "agentPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "basis": "FIRST_VERIFIED_LISTER",
    "status": "ACTIVE",
    "grantedAt": "2026-09-25T10:00:00Z",
    "expiresAt": "2026-09-25T10:00:00Z",
    "supersededReason": "string"
  },
  "description": "Agent delisted successfully"
}

Responses

Status	When
`200`	Agent delisted successfully
`409`	You are not the verified owner

POST Grant a listing to an agent

POST /rental/landlord/unit/{reference}/grant

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`agentPartyReference`	Optional

Example

Response: GenericResponseListingClaimResponse

curl -X POST "https://api.bridgemoni.com/rental/landlord/unit/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/grant?agentPartyReference=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "agentPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "basis": "FIRST_VERIFIED_LISTER",
    "status": "ACTIVE",
    "grantedAt": "2026-09-25T10:00:00Z",
    "expiresAt": "2026-09-25T10:00:00Z",
    "supersededReason": "string"
  },
  "description": "Listing granted successfully"
}

Responses

Status	When
`200`	Listing granted successfully

POST Accept the proposed renewal

POST /rental/tenancy/{reference}/renewal/accept

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseRenewalProposalResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/renewal/accept" \
  -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",
    "rentAmount": 0,
    "commencementDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "status": "PROPOSED",
    "termsVersion": 0,
    "decidedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Renewal accepted successfully"
}

Responses

Status	When
`200`	Renewal accepted successfully
`404`	There is no open renewal proposal

POST Decline the proposed renewal

POST /rental/tenancy/{reference}/renewal/decline

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseRenewalProposalResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/renewal/decline" \
  -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",
    "rentAmount": 0,
    "commencementDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "status": "PROPOSED",
    "termsVersion": 0,
    "decidedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Renewal declined successfully"
}

Responses

Status	When
`200`	Renewal declined successfully

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