Bridge
Contact us
API reference · Identity & onboarding

Properties

GET List a property for an account holder

GET /accountholder/{type}/{value}/properties

Headers

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

Path parameters

Name
type
value

Example

Response: GenericResponseListPropertyResponse

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

Responses

StatusWhen
200A property fetched successfully

POST Record a property for an account holder

POST /accountholder/{type}/{value}/property

Headers

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

Path parameters

Name
type
value

Example

Request body: PropertyRequest · Response: GenericResponsePropertyResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/property" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "marketCode": "NG-LA",
  "propertyType": "BLOCK_OF_FLATS",
  "displayName": "Adeola Court",
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressLine": "12 Adeola Odeku Street",
  "area": "Victoria Island",
  "city": "Lagos",
  "latitude": 0,
  "longitude": 0
}'

Responses

StatusWhen
200A property recorded successfully

GET Fetch one record

GET /property/{id}

Headers

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

Path parameters

Name
id

Example

Response: GenericResponsePropertyResponse

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

Responses

StatusWhen
200A property fetched successfully

PUT Update one record

PUT /property/{id}

Headers

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

Path parameters

Name
id

Example

Request body: UpdatePropertyRequest · Response: GenericResponsePropertyResponse

curl -X PUT "https://api.bridgemoni.com/property/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 '{
  "titleReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "registryName": {
    "name": "string"
  },
  "registryCountryCode": "string",
  "registryRegion": {
    "name": "string"
  },
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "propertyType": "RESIDENTIAL",
  "landUse": "RESIDENTIAL",
  "certificateOfOccupancyNumber": "string",
  "certificateOfOccupancyIssueDate": "2026-09-25",
  "certificateOfOccupancyExpiryDate": "2026-09-25",
  "acquiredDate": "2026-09-25",
  "ownershipShare": {
    "rate": 0
  },
  "encumbered": "true",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "active": "true"
}'

Responses

StatusWhen
200A property updated successfully

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