API reference · Communities & institutions

Rentals landlords

POST/rental/invitation/{code}/claimClaim a party invitation
POST/rental/landlord/ownership-claimClaim a property, with evidence
GET/rental/landlord/payout-instrumentYour payout accounts, including refused ones
POST/rental/landlord/payout-instrumentNominate a payout account
GET/rental/landlord/settlementYour settlements and their items
GET/rental/landlord/settlement/{reference}One settlement statement
POST/rental/landlord/tax-residencyDeclare tax residency
POST/rental/landlord/tenancy/{reference}/confirmConfirm an occupant-registered tenancy
GET/rental/landlord/withholding/statementWhat was withheld, per period, for your return

POST Claim a party invitation

POST /rental/invitation/{code}/claim

The person who was named as a landlord, agent or estate claims the party with the code they were given. Claiming makes them a party to the tenancy; it does not verify them.

Headers

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

Path parameters

Name
`code`

Example

Response: GenericResponseInvitationClaimResponse

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

{
  "data": {
    "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"
    },
    "tenancyReferences": [
      "string"
    ]
  },
  "description": "Invitation claimed successfully"
}

Responses

Status	When
`200`	Invitation claimed successfully
`404`	No open invitation has that code
`409`	The invitation has expired

POST Claim a property, with evidence

POST /rental/landlord/ownership-claim

Headers

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

Example

Request body: OwnershipClaimRequest · Response: GenericResponseOwnershipClaimResponse

curl -X POST "https://api.bridgemoni.com/rental/landlord/ownership-claim" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "claimType": "TITLE",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "claimType": "TITLE",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "claimType": "TITLE",
    "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "grade": "G0_ASSERTED",
    "status": "PENDING",
    "decisionReason": "string",
    "decidedAt": "2026-09-25T10:00:00Z",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Ownership claim filed successfully"
}

Responses

Status	When
`200`	Ownership claim filed successfully

GET Your payout accounts, including refused ones

GET /rental/landlord/payout-instrument

Headers

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

Example

Response: GenericResponseListPayoutInstrumentResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "kind": "BANK_ACCOUNT",
      "status": "ACTIVE",
      "currencyCode": "string",
      "bankCode": "string",
      "accountNumberMasked": "string",
      "nameEnquiryOutcome": "MATCHED",
      "resolvedName": "string",
      "checkedAt": "2026-09-25T10:00:00Z",
      "refusalReason": "string"
    }
  ],
  "description": "Payout accounts retrieved successfully"
}

Responses

Status	When
`200`	Payout accounts retrieved successfully

POST Nominate a payout account

POST /rental/landlord/payout-instrument

A bank account is usable only when the name the bank returns matches the verified landlord's name. A mismatch does not warn; it refuses, with the reason that will still be true tomorrow. A wallet must be your own main wallet.

Headers

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

Example

Request body: PayoutInstrumentRequest · Response: GenericResponsePayoutInstrumentResponse

curl -X POST "https://api.bridgemoni.com/rental/landlord/payout-instrument" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "BANK_ACCOUNT",
  "currencyCode": "NGN",
  "bankCode": "058",
  "accountNumber": "0123456789"
}'

{
  "kind": "BANK_ACCOUNT",
  "currencyCode": "NGN",
  "bankCode": "058",
  "accountNumber": "0123456789"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kind": "BANK_ACCOUNT",
    "status": "ACTIVE",
    "currencyCode": "string",
    "bankCode": "string",
    "accountNumberMasked": "string",
    "nameEnquiryOutcome": "MATCHED",
    "resolvedName": "string",
    "checkedAt": "2026-09-25T10:00:00Z",
    "refusalReason": "string"
  },
  "description": "Payout account registered successfully"
}

Responses

Status	When
`200`	Payout account registered successfully
`409`	The name does not match, the bank could not answer, or the landlord is not yet verified

GET Your settlements and their items

GET /rental/landlord/settlement

Headers

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

Example

Response: GenericResponseListSettlementResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "occurrenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "kind": "ADVANCE",
      "gross": "string",
      "fees": "string",
      "railFees": "string",
      "advances": "string",
      "reserve": "string",
      "debits": "string",
      "net": "string",
      "currency": "string",
      "status": "CALCULATED",
      "holdReason": "string",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Settlements retrieved successfully"
}

Responses

Status	When
`200`	Settlements retrieved successfully

GET One settlement statement

GET /rental/landlord/settlement/{reference}

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseSettlementResponse

curl -X GET "https://api.bridgemoni.com/rental/landlord/settlement/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",
    "occurrenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kind": "ADVANCE",
    "gross": "string",
    "fees": "string",
    "railFees": "string",
    "advances": "string",
    "reserve": "string",
    "debits": "string",
    "net": "string",
    "currency": "string",
    "status": "CALCULATED",
    "holdReason": "string",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Settlement retrieved successfully"
}

Responses

Status	When
`200`	Settlement retrieved successfully
`404`	No settlement of yours has that reference

POST Declare tax residency

POST /rental/landlord/tax-residency

Recorded as a claim until an operator checks the evidence. Until then payouts are withheld from as if you were non-resident, because withholding wrongly costs a refund and not withholding costs somebody else the tax.

Headers

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

Example

Request body: TaxResidencyRequest · Response: GenericResponsePartyResponse

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

{
  "residency": "RESIDENT",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "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"
  },
  "description": "Tax residency recorded successfully"
}

Responses

Status	When
`200`	Tax residency recorded successfully

POST Confirm an occupant-registered tenancy

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

The tenancy becomes ACTIVE and its terms counterparty-confirmed. Money can move only once you are verified and have a name-checked payout account. Payments recorded before confirmation keep their grade.

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: TenancyConfirmationRequest · Response: GenericResponseTenancyConfirmationResponse

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

{
  "confirmsTerms": true,
  "payoutInstrumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "correctedRentAmount": 0,
  "narrative": "string"
}

{
  "data": {
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "DRAFT",
    "moneyPosture": "EVIDENCE_ONLY",
    "assuranceGrade": "G0_ASSERTED",
    "landlordParty": {
      "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"
    },
    "payoutInstrument": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "kind": "BANK_ACCOUNT",
      "status": "ACTIVE",
      "currencyCode": "string",
      "bankCode": "string",
      "accountNumberMasked": "string",
      "nameEnquiryOutcome": "MATCHED",
      "resolvedName": "string",
      "checkedAt": "2026-09-25T10:00:00Z",
      "refusalReason": "string"
    },
    "historicalEvidence": {
      "count": 0,
      "assuranceGrade": "G0_ASSERTED",
      "note": "string"
    },
    "capabilities": {
      "canPayRentThroughPlatform": true,
      "canHoldDeposit": true,
      "canRecordEvidence": true,
      "canRegisterTenancy": true,
      "refusalReason": "string"
    }
  },
  "description": "Tenancy confirmed successfully"
}

Responses

Status	When
`200`	Tenancy confirmed successfully
`400`	The terms were not confirmed as registered
`409`	The tenancy is not waiting for its landlord

GET What was withheld, per period, for your return

GET /rental/landlord/withholding/statement

Headers

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

Example

Response: GenericResponseWithholdingStatementResponse

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

{
  "data": {
    "landlordPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "totalGross": 0,
    "totalWithheld": 0,
    "lines": [
      {
        "settlementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "period": "string",
        "marketCode": "string",
        "grossAmount": 0,
        "withheldAmount": 0,
        "ratePercent": 0,
        "residency": "RESIDENT",
        "basis": "string",
        "remitted": true
      }
    ]
  },
  "description": "Withholding statement retrieved successfully"
}

Responses

Status	When
`200`	Withholding statement retrieved successfully

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