API reference · Communities & institutions

Rentals deposits

GET/rental/tenancy/{reference}/depositThe deposit, and who holds it
POST/rental/tenancy/{reference}/deposit/claimClaim against the deposit
POST/rental/tenancy/{reference}/deposit/claim/acceptAccept the landlord's claim
POST/rental/tenancy/{reference}/deposit/claim/withdrawWithdraw a claim
POST/rental/tenancy/{reference}/deposit/confirm-returnConfirm the landlord returned a deposit they held
POST/rental/tenancy/{reference}/deposit/inspectionRecord the move-out inspection
POST/rental/tenancy/{reference}/deposit/payPay the caution deposit

GET The deposit, and who holds it

GET /rental/tenancy/{reference}/deposit

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseDepositResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit" \
  -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",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Deposit retrieved successfully"
}

Responses

Status	When
`200`	Deposit retrieved successfully

POST Claim against the deposit

POST /rental/tenancy/{reference}/deposit/claim

Landlord only, itemised and evidenced from the tenancy's vault, before the window closes. Only the claimed amount is held back; the rest returns on schedule.

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: DepositClaimRequest · Response: GenericResponseDepositResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit/claim" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "description": "Replace kitchen window pane",
      "amount": 35000.0,
      "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ]
}'

{
  "items": [
    {
      "description": "Replace kitchen window pane",
      "amount": 35000.0,
      "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Claim filed successfully"
}

Responses

Status	When
`200`	Claim filed successfully
`400`	Not itemised, not evidenced, or more than the deposit
`409`	Window closed or already claimed

POST Accept the landlord's claim

POST /rental/tenancy/{reference}/deposit/claim/accept

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseDepositResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit/claim/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",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Claim accepted successfully"
}

Responses

Status	When
`200`	Claim accepted successfully

POST Withdraw a claim

POST /rental/tenancy/{reference}/deposit/claim/withdraw

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseDepositResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit/claim/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",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Claim withdrawn successfully"
}

Responses

Status	When
`200`	Claim withdrawn successfully

POST Confirm the landlord returned a deposit they held

POST /rental/tenancy/{reference}/deposit/confirm-return

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseDepositResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit/confirm-return" \
  -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",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Return confirmed successfully"
}

Responses

Status	When
`200`	Return confirmed successfully

POST Record the move-out inspection

POST /rental/tenancy/{reference}/deposit/inspection

Starts the claim window. An inspection nobody records within the inspection period is recorded as not held and the window starts anyway.

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: DepositInspectionRequest · Response: GenericResponseDepositResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit/inspection" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "inspectedAt": "2026-09-25T10:00:00Z",
  "notes": "Walls repainted, one broken window pane in the kitchen",
  "evidenceDocumentReferences": [
    "string"
  ]
}'

{
  "inspectedAt": "2026-09-25T10:00:00Z",
  "notes": "Walls repainted, one broken window pane in the kitchen",
  "evidenceDocumentReferences": [
    "string"
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Inspection recorded successfully"
}

Responses

Status	When
`200`	Inspection recorded successfully

POST Pay the caution deposit

POST /rental/tenancy/{reference}/deposit/pay

Into the custody the market's law allows: held by the platform in escrow, or recorded as held by the landlord. Refused in a market with no lawful custodian, and says who holds the money. Requires the transaction PIN where money moves.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Idempotency-Key`	Reuse the same value on every retry of this request

Path parameters

Name
`reference`

Example

Response: GenericResponseDepositResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/deposit/pay" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "AWAITING_FUNDING",
    "heldBy": "PLATFORM",
    "custodyRegime": "PLATFORM_ESCROW",
    "custodianName": "string",
    "amount": 0,
    "currencyCode": "string",
    "fundedAt": "2026-09-25T10:00:00Z",
    "moveOutDate": "2026-09-25",
    "inspectionOutcome": "HELD",
    "inspectedAt": "2026-09-25T10:00:00Z",
    "inspectionDeadline": "2026-09-25T10:00:00Z",
    "windowClosesAt": "2026-09-25T10:00:00Z",
    "claimStatus": "OPEN",
    "claimedAmount": 0,
    "claimItems": [
      {
        "description": "string",
        "amount": 0,
        "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "returnedToOccupant": 0,
    "paidToLandlord": 0,
    "releaseBases": [
      "SILENCE_RETURNS_TO_OCCUPANT"
    ]
  },
  "description": "Deposit paid successfully"
}

Responses

Status	When
`200`	Deposit paid successfully
`409`	No custodian, no deposit in the terms, already paid, or not yet confirmed by the landlord

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