API reference · Communities & institutions

Rental tenancies

GET/rental/tenancyTenancies you are party to, as occupant, landlord or agent
POST/rental/tenancyRegister the tenancy you live in
GET/rental/tenancy/{reference}One tenancy, with its grades, market block and capabilities
GET/rental/tenancy/{reference}/documentThe tenancy's document vault, with short-lived download links
POST/rental/tenancy/{reference}/documentUpload an agreement, receipt or photo to the tenancy's vault
GET/rental/tenancy/{reference}/evidenceReported off-platform payments for a tenancy
POST/rental/tenancy/{reference}/evidenceRecord an off-platform payment
POST/rental/tenancy/{reference}/proceed-aloneProceed without the landlord
GET/rental/tenancy/{reference}/scheduleThe rent schedule: every charge, its period and its status
GET/rental/tenancy/{reference}/statementStatement, grade-labelled
PATCH/rental/tenancy/{reference}/termsAmend the terms of a tenancy you hold alone

GET Tenancies you are party to, as occupant, landlord or agent

GET /rental/tenancy

Headers

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

Example

Response: GenericResponseListTenancyResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "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",
      "currentlyResident": "true",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Tenancies retrieved successfully"
}

Responses

Status	When
`200`	Tenancies retrieved successfully

POST Register the tenancy you live in

POST /rental/tenancy

The single-player entry point: no landlord is needed. The landlord you name is invited to claim, and until a verified landlord with a name-checked payout account does, the tenancy is EVIDENCE_ONLY and can never move money. Statutory checks are made under the market profile version in force today, and that version is frozen onto the tenancy.

Headers

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

Example

Request body: TenancyRequest · Response: GenericResponseTenancyResponse

curl -X POST "https://api.bridgemoni.com/rental/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"
}'

{
  "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"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "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",
    "currentlyResident": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "RentalTenancy registered successfully"
}

Responses

Status	When
`200`	RentalTenancy registered successfully
`400`	The terms break the market's rules: advance period, deposit cap, a charge the occupant may not bear, or a notice period shorter than the statutory one
`409`	The unit is already let, or the market is not enabled

GET One tenancy, with its grades, market block and capabilities

GET /rental/tenancy/{reference}

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseTenancyResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/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",
    "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",
    "currentlyResident": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "RentalTenancy retrieved successfully"
}

Responses

Status	When
`200`	RentalTenancy retrieved successfully
`404`	No tenancy you are party to

GET The tenancy's document vault, with short-lived download links

GET /rental/tenancy/{reference}/document

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListTenancyDocumentResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/document" \
  -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",
      "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "documentType": "TENANCY_AGREEMENT",
      "originalFilename": "string",
      "contentType": "string",
      "sizeBytes": 0,
      "checksumSha256": "string",
      "assuranceGrade": "G0_ASSERTED",
      "uploadedByPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "downloadUrl": "string",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Documents retrieved successfully"
}

Responses

Status	When
`200`	Documents retrieved successfully

POST Upload an agreement, receipt or photo to the tenancy's vault

POST /rental/tenancy/{reference}/document

Stored in the document store, never through a provider, and graded G2_DOCUMENTED: present, not adjudicated.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	multipart/form-data

Path parameters

Name
`reference`

Query parameters

Name	Default
`documentType`	Optional

Example

Request body: object · Response: GenericResponseTenancyDocumentResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/document?documentType=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -F "file=@./document.pdf"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "documentType": "TENANCY_AGREEMENT",
    "originalFilename": "string",
    "contentType": "string",
    "sizeBytes": 0,
    "checksumSha256": "string",
    "assuranceGrade": "G0_ASSERTED",
    "uploadedByPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "downloadUrl": "string",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Document uploaded successfully"
}

Responses

Status	When
`200`	Document uploaded successfully
`400`	The file is empty

GET Reported off-platform payments for a tenancy

GET /rental/tenancy/{reference}/evidence

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListEvidencePaymentResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/evidence" \
  -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",
      "amount": 0,
      "currencyCode": "string",
      "paidOn": "2026-09-25",
      "method": "CASH",
      "coversPeriodStart": "2026-09-25",
      "coversPeriodEnd": "2026-09-25",
      "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "note": "string",
      "assuranceGrade": "G0_ASSERTED",
      "isReceipt": true,
      "affectsBalance": true,
      "appearsInSettlement": true,
      "disclaimer": "string",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Evidence retrieved successfully"
}

Responses

Status	When
`200`	Evidence retrieved successfully

POST Record an off-platform payment

POST /rental/tenancy/{reference}/evidence

Evidence, not a receipt. It is graded G0_ASSERTED forever, settles no charge, and never appears in a settlement.

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: EvidencePaymentRequest · Response: GenericResponseEvidencePaymentResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/evidence" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 2000000.0,
  "currencyCode": "NGN",
  "paidOn": "2025-03-01",
  "method": "CASH",
  "coversPeriodStart": "2026-09-25",
  "coversPeriodEnd": "2026-09-25",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "note": "Paid to landlord'\''s GTB account, teller attached"
}'

{
  "amount": 2000000.0,
  "currencyCode": "NGN",
  "paidOn": "2025-03-01",
  "method": "CASH",
  "coversPeriodStart": "2026-09-25",
  "coversPeriodEnd": "2026-09-25",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "note": "Paid to landlord's GTB account, teller attached"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "amount": 0,
    "currencyCode": "string",
    "paidOn": "2026-09-25",
    "method": "CASH",
    "coversPeriodStart": "2026-09-25",
    "coversPeriodEnd": "2026-09-25",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "note": "string",
    "assuranceGrade": "G0_ASSERTED",
    "isReceipt": true,
    "affectsBalance": true,
    "appearsInSettlement": true,
    "disclaimer": "string",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Evidence recorded successfully"
}

Responses

Status	When
`200`	Evidence recorded successfully
`400`	The amount, currency or date is not usable

POST Proceed without the landlord

POST /rental/tenancy/{reference}/proceed-alone

The tenancy keeps records, reminders and evidence and moves no money. It returns to the normal path when the landlord claims later.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseTenancyResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "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",
    "currentlyResident": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "RentalTenancy is now evidence-only"
}

Responses

Status	When
`200`	RentalTenancy is now evidence-only
`409`	The tenancy is not waiting for a landlord

GET The rent schedule: every charge, its period and its status

GET /rental/tenancy/{reference}/schedule

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseTenancyScheduleResponse

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

{
  "data": {
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "termsVersion": 0,
    "nextDueDate": "2026-09-25",
    "charges": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "chargeType": "RENT",
        "periodStart": "2026-09-25",
        "periodEnd": "2026-09-25",
        "dueDate": "2026-09-25",
        "amount": 0,
        "amountSettled": 0,
        "currencyCode": "string",
        "status": "BEFORE_REGISTRATION",
        "borneBy": "OCCUPANT",
        "termsVersion": 0
      }
    ]
  },
  "description": "Schedule retrieved successfully"
}

Responses

Status	When
`200`	Schedule retrieved successfully

GET Statement, grade-labelled

GET /rental/tenancy/{reference}/statement

Observed money (G4) and reported payments (G0) appear on separate lines and in separate totals. A reported payment is never added to what was observed.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseTenancyStatementResponse

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

{
  "data": {
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "totalCharged": 0,
    "totalObserved": 0,
    "totalAsserted": 0,
    "lines": [
      {
        "on": "2026-09-25",
        "kind": "string",
        "narrative": "string",
        "amount": 0
      }
    ]
  },
  "description": "Statement retrieved successfully"
}

Responses

Status	When
`200`	Statement retrieved successfully

PATCH Amend the terms of a tenancy you hold alone

PATCH /rental/tenancy/{reference}/terms

Writes a new terms version; the old one is superseded, never edited, and the schedule is rebuilt under the new version. Once a landlord has confirmed the terms, a change is a proposal the other party must accept.

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: TermsAmendmentRequest · Response: GenericResponseTenancyResponse

curl -X PATCH "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/terms" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "rentAmount": 0,
  "rentCadence": "MONTHLY",
  "commencementDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "depositAmount": 0,
  "noticePeriodDays": 0,
  "narrative": "Rent corrected after checking the agreement"
}'

{
  "rentAmount": 0,
  "rentCadence": "MONTHLY",
  "commencementDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "depositAmount": 0,
  "noticePeriodDays": 0,
  "narrative": "Rent corrected after checking the agreement"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "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",
    "currentlyResident": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "RentalTenancy terms amended successfully"
}

Responses

Status	When
`200`	RentalTenancy terms amended successfully
`409`	The landlord has confirmed the terms

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