Bridge
Contact us
API reference · Identity & onboarding

Tenancies

GET List a tenancy for an account holder

GET /accountholder/{type}/{value}/tenancies

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
type
value

Example

Response: GenericResponseListTenancyResponse

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

Responses

StatusWhen
200A tenancy fetched successfully

POST Record a tenancy for an account holder

POST /accountholder/{type}/{value}/tenancy

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
type
value

Example

Request body: TenancyRequest · Response: GenericResponseTenancyResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/tenancy" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "landlord": {
    "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "displayName": "Mr Adeyemi Okonkwo",
    "contactMsisdn": "2348035016064",
    "contactEmail": "adeyemi@example.com"
  },
  "agent": {
    "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "displayName": "Mr Adeyemi Okonkwo",
    "contactMsisdn": "2348035016064",
    "contactEmail": "adeyemi@example.com"
  },
  "rentAmount": 2000000.0,
  "rentCurrencyCode": "NGN",
  "rentCadence": "MONTHLY",
  "commencementDate": "2026-03-01",
  "expiryDate": "2027-02-28",
  "depositAmount": 200000.0,
  "noticePeriodDays": 180,
  "narrative": "3 bedroom flat, Block C Flat 4"
}'

Responses

StatusWhen
200A tenancy recorded successfully

GET Fetch one record

GET /tenancy/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
id

Example

Response: GenericResponseTenancyResponse

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

Responses

StatusWhen
200A tenancy fetched successfully

PUT Update one record

PUT /tenancy/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
id

Example

Request body: UpdateTenancyRequest · Response: GenericResponseTenancyResponse

curl -X PUT "https://api.bridgemoni.com/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "landlordName": {
    "name": "string"
  },
  "landlordContact": "string",
  "landlordUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "agentName": {
    "name": "string"
  },
  "termStart": "2026-09-25",
  "termEnd": "2026-09-25",
  "rentBand": "string",
  "currencyCode": "string",
  "paymentFrequency": "WEEKLY",
  "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "tenancyStatus": "PENDING",
  "active": "true"
}'

Responses

StatusWhen
200A tenancy updated successfully

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