Raynix - AI Call Handling for Property & Facilities Teams

Introduction

Welcome to the Raynix Property API — a powerful interface for third-party integrations with the Raynix property management system. This API allows authorized partners to:

Authenticate securely using JWT tokens
Create, update, delete, and reactivate property listings
Manage property status (Available, Sold, and Rented.)
Manage property media type (images and videos.)
Retrieve consistent responses for integration monitoring

All endpoints use JSON and secure Bearer token authorization.

Overview

Base URLs used by endpoints in this portal.

BASE_URL_AUTH = https://authorisation-test.raynix.uk/api/Auth
BASE_URL = https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ

Property API Payload Specification

Field	Type	Description
propertiesReferenceNumber	string	Unique numeric reference number for the property. Must contain digits only to support phone dial validation.
title	string	Title of the property listing
flatNumber	string	Flat number (e.g. Flat 12) if applicable
address	string	Full address of the property
price	number	Monthly rental price
bedrooms	number	Number of bedrooms
bathrooms	number	Number of bathrooms
area	string	Total area of the property (e.g. 850 sqft)
description	string	Detailed description of the property, features, and location
agentCode	string (GUID)	Unique identifier for the assigned agent
status	string	Property status: Available Reserved Rented Notice Given Under Maintenance Off Market
sellingPrice	number	Selling price (used when property is for sale)
postCode	string	Property postcode
isStudentAllowed	boolean	Indicates whether students are allowed
isPensionerAllowed	boolean	Indicates whether pensioners are allowed
isForRent	boolean	Indicates if the property is available for rent
isForSelling	boolean	Indicates if the property is available for sale
depositPrice	number	Required tenancy deposit amount
holdingDepositAmount	number	Holding deposit amount required to reserve the property (typically capped at one week’s rent under UK regulations)
zeroDepositSchemeAvailable	boolean	Indicates whether a zero-deposit scheme is available as an alternative to a traditional deposit
epcRating	string	Energy Performance Certificate (EPC) rating
availableDate	string (ISO 8601)	Date when the property becomes available
isFurnished	boolean	Indicates whether the property is furnished
isHouseShared	boolean	Indicates whether the property is a shared house
maximumOccupants	number	Maximum number of occupants permitted under tenancy, licensing, or safety regulations
isSubjectToLocalLicensingScheme	boolean	Indicates whether the property falls under a local authority licensing scheme (e.g. Selective, Additional, or HMO licensing)
councilTaxBand	string	Council tax band assigned by the local authority (Bands A–H)
floodRiskLevel	string	Flood risk classification for the property (e.g. Very Low, Low, Medium, High)
electricity	boolean	Electricity supply available
gas	boolean	Gas supply available
privateGarden	boolean	Indicates presence of a private garden
offStreetParking	boolean	Off-street parking availability
allowPublicView	boolean	Allows the property to be publicly visible
parking	boolean	Parking availability
stepFreeAccess	boolean	Indicates whether the property offers step-free access
liftAccessAvailable	boolean	Indicates whether lift access is available (where applicable)
isSmokingAllowed	boolean	Indicates whether smoking is allowed
isPetAllowed	boolean	Indicates whether pets are allowed
dssCoveredRent	boolean	Indicates if DSS / benefits-supported tenants are accepted
isFirePlace	boolean	Indicates whether the property has a fireplace
minimumTenancy	number	Minimum tenancy duration in months
PropertyType	string	Type of property. Allowed values: Residential, Commercial.
media	array	Media items related to the property mediaId (string): Unique media identifier type (string): Media type (image/video) url (string): Public media URL fileName (string): Original file name

API Responses

Scenario	Response Code	Response Body	Description
Authentication Failed	401	View response { "responseCode": "401", "responseMessage": "Invalid or expired authorization token. Please log in again." }	Authorization token is missing, invalid, or expired.
Authentication Successful	00	View response { "status": { "responseCode": "00", "responseMessage": "Successful" }, "token": "eyJ......", "expiresIn": 15777600 }	Authentication succeeded. Token and expiry are returned.
Request Successful	00	{ "responseCode": "00", "responseMessage": "Successful" }	Request completed successfully.
Request Failed	01	{ "responseCode": "01", "responseMessage": "Failed" }	Request failed due to processing error.
Validation Failed	06	View errors { "responseCode": "06", "responseMessage": "Validation failed", "error": [ "Status must be one of: Available, Reserved, Rented, Notice Given, Under Maintenance, Off Market" ] }	Validation errors occurred. See error list for details.

Authentication

Authenticate a user and receive a JWT token. Note this base URL differs from the AgentIQ endpoints.

POST

https://authorisation-test.raynix.uk/api/Auth/login

Headers

Accept: */*
Content-Type: application/json

Payload

cURL example

{
  "username": "apitesting@raynix.uk",
  "password": "Hp_AscPVRPogaeWpRJwgnCNh017_NMgPl6ymTgvdBguD1EFuZXRcNWTLNAeEHE7-"
}

Success Response (200)

{
  "status": {
    "responseCode": "00",
    "responseMessage": "Successful"
  },
  "token": "eyJ......",
  "expiresIn": 15777600
}

Failure Response (Invalid Username)

{
  "status": {
    "responseCode": "09",
    "responseMessage": "Invalid Username"
  },
  "expiresIn": 0
}

Add Property

Create a new property listing with metadata and media.

POST

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/AddProperty

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "000121",
  "title": "Modern 2-Bedroom Apartment",
  "flatNumber": "Flat 12",
  "address": "Flat 12, Greenview Estate, Canary Wharf, London",
  "price": 1500,
  "bedrooms": 2,
  "bathrooms": 1,
  "area": "850 sqft",
  "description": "A modern 2-bedroom apartment located close to public transport and shopping centres.",
  "agentCode": "06745d25-47af-47f8-9918-a37a4004714e",
  "status": "AVAILABLE_RENT",
  "sellingPrice": 0,
  "postCode": "E14 9AB",
  "isStudentAllowed": true,
  "isPensionerAllowed": false,
  "isForRent": true,
  "isForSelling": false,
  "depositPrice": 1500,
  "epcRating": "B",
  "availableDate": "2025-01-20T00:00:00Z",
  "isFurnished": true,
  "isHouseShared": false,
  "electricity": true,
  "gas": true,
  "privateGarden": false,
  "offStreetParking": true,
  "allowPublicView": true,
  "parking": true,
  "isSmokingAllowed": false,
  "isPetAllowed": true,
  "dssCoveredRent": true,
  "isFirePlace": false,
  "minimumTenancy": 12,
  "propertyType": "Residential",
  "holdingDepositAmount": 300,
  "zeroDepositSchemeAvailable": true,
  "maximumOccupants": 3,
  "isSubjectToLocalLicensingScheme": false,
  "councilTaxBand": "D",
  "floodRiskLevel": "Very Low",
  "stepFreeAccess": true,
  "liftAccessAvailable": true,
  "media": [
    {
      "mediaId": "IMG-003",
      "type": "image",
      "url": "https://cdn.agentiq.com/properties/prop-uk-000123/front-view.jpg",
      "fileName": "front-view.jpg"
    },
    {
      "mediaId": "IMG-004",
      "type": "image",
      "url": "https://cdn.agentiq.com/properties/prop-uk-000123/living-room.jpg",
      "fileName": "living-room.jpg"
    }
  ]
}

curl -X 'POST' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/AddProperty' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "487374", "title": "Three Bedroom flat", "address": "LU1 3UT", "price": 1100, "bedrooms": 3, "bathrooms": 1, "area": "127", "description": "Three Bedroom flat", "agentCode": "06745d25-47af-47f8-9918-a37a4004714e", "status": "Rent", "sellingPrice": 0, "postCode": "LU1 3UT", "country": "United Kingdom", "media": [{ "mediaId": "LU14USK-02", "type": "image", "url": "https://example.com/photo1.jpg" }] }'

Success Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Failure Response (422)

{
  "responseCode": "01",
  "responseMessage": "Failed"
}

Property Status Codes

The Property Status field represents the current lifecycle state of a property.
API consumers must pass the Code value only. Display values are provided for reference purposes and must not be used in API requests.

Code	Display Value	Category	Description
`AVAILABLE_RENT`	Available for Rent Only	Availability	Property is listed for rent only and currently available.
`AVAILABLE_SALE`	Available for Sale Only	Availability	Property is listed for sale only and currently available.
`AVAILABLE_BOTH`	Available for Rent and Sale	Availability	Property is available for both rent and sale.
`COMING_SOON`	Coming Soon	Availability	Property will be available soon but is not yet active.
`VACANT`	Vacant	Occupancy	Property is empty and ready for occupancy.
`OCCUPIED`	Occupied	Occupancy	Property is currently occupied.
`RESERVED`	Reserved	Transaction	Property has been reserved by a potential tenant or buyer.
`PENDING`	Pending	Transaction	An offer has been submitted and is awaiting completion.
`UNDER_CONTRACT`	Under Contract	Transaction	A legal contract is in progress.
`OFFER_ACCEPTED`	Offer Accepted	Transaction	An offer has been accepted but not yet finalized.
`BACK_ON_MARKET`	Back on Market	Transaction	A previous deal fell through and the property was relisted.
`SOLD`	Sold	Finalized	The property sale has been completed.
`RENTED`	Rented	Finalized	The property rental has been completed.
`LEASE_SIGNED`	Lease Signed	Rental	A lease agreement has been signed.
`LEASE_EXPIRING`	Lease Expiring	Rental	The lease is nearing its end date.
`NOTICE_GIVEN`	Notice Given	Rental	The tenant has provided notice to vacate.
`UNDER_MAINTENANCE`	Under Maintenance	Operations	The property is temporarily unavailable due to maintenance.
`RENOVATION`	Renovation in Progress	Operations	The property is undergoing renovation works.
`INSPECTION`	Inspection Scheduled	Operations	An inspection is scheduled or in progress.
`REPAIR_REQUIRED`	Repair Required	Operations	Repairs are required before the property can be occupied.
`READY`	Ready for Occupancy	Operations	The property is fully prepared for occupation.
`TEMP_UNAVAILABLE`	Temporarily Unavailable	Administrative	The property is unavailable due to administrative reasons.
`WITHDRAWN`	Withdrawn	Administrative	The listing has been withdrawn by the owner or agent.
`EXPIRED`	Expired Listing	Administrative	The listing expired without a completed transaction.
`OFF_MARKET`	Off Market	Administrative	The property is no longer being marketed.

Update Property

Update details of an existing property (by reference number).

PUT

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/UpdateProperty

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "000121",
  "title": "Modern 2-Bedroom Apartment",
  "flatNumber": "Flat 12",
  "address": "Flat 12, Greenview Estate, Canary Wharf, London",
  "price": 1500,
  "bedrooms": 2,
  "bathrooms": 1,
  "area": "850 sqft",
  "description": "A modern 2-bedroom apartment located close to public transport and shopping centres.",
  "agentCode": "06745d25-47af-47f8-9918-a37a4004714e",
  "status": "RESERVED",
  "sellingPrice": 0,
  "postCode": "E14 9AB",
  "isStudentAllowed": true,
  "isPensionerAllowed": false,
  "isRentAvailable": true,
  "isSaleAvailable": false,
  "isForRent": true,
  "isForSelling": false,
  "depositPrice": 1700,
  "epcRating": "B",
  "availableDate": "2025-01-20T00:00:00Z",
  "isFurnished": true,
  "isHouseShared": false,
  "electricity": true,
  "gas": true,
  "privateGarden": false,
  "offStreetParking": true,
  "allowPublicView": true,
  "parking": true,
  "isSmokingAllowed": false,
  "isPetAllowed": true,
  "dssCoveredRent": true,
  "isFirePlace": false,
  "minimumTenancy": 6,
  "propertyType": "Residential",
  "holdingDepositAmount": 300,
  "zeroDepositSchemeAvailable": true,
  "maximumOccupants": 3,
  "isSubjectToLocalLicensingScheme": false,
  "councilTaxBand": "D",
  "floodRiskLevel": "Very Low",
  "stepFreeAccess": true,
  "liftAccessAvailable": true,
  "media": [
    {
      "mediaId": "IMG-003",
      "type": "image",
      "url": "https://cdn.agentiq.com/properties/prop-uk-000123/front-view.jpg",
      "fileName": "front-view.jpg"
    },
    {
      "mediaId": "IMG-004",
      "type": "image",
      "url": "https://cdn.agentiq.com/properties/prop-uk-000123/living-room.jpg",
      "fileName": "living-room.jpg"
    }
  ]
}

curl -X 'PUT' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/UpdateProperty' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "4873756", "title": "Three Bedroom flat", "address": "LU1 3UT", "price": 1200, "bedrooms": 3, "bathrooms": 2, "area": "127", "description": "Three Bedroom flat", "agentCode": "06745d25-47af-47f8-9918-a37a4004714e", "status": "Rent", "sellingPrice": 0, "postCode": "LU1 3UT", "country": "United Kingdom", "isStudentAllowed": true, "isPensionerAllowed": true, "isRentAvailable": true, "isSaleAvailable": true, "media": [{ "mediaId": "LU14USK-06", "type": "image", "url": "https://example.com/photo11.jpg" }] }'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Lock Property

Lock a property by its property reference number (path parameter).

DELETE

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/{propertreferencenumber}

cURL Example

curl -X 'DELETE' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/4873759' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Reactivate Property

Reactivate a previously lock property via its reference number.

PUT

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivateProperty

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "4873759"
}

curl -X 'PUT' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivateProperty' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "4873759" }'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Lock Property Media

Lock a media item attached to a property (path parameters: property reference number and mediaId).

DELETE

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/{propertreferencenumber}/media/{mediaId}

Example cURL

curl -X 'DELETE' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/4873759/media/LU14USK-08' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Reactivate Property Media

Reactivate a lock media item for a property.

PUT

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivatePropertyMedia

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "4873759",
  "mediaId": "LU14USK-08"
}

curl -X 'PUT' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivatePropertyMedia' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "4873759", "mediaId": "LU14USK-08" }'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}