RAYNIX API

Build with Raynix.

Connect your property management platform, CRM or operational system to Raynix using our secure API.

Start integrating Explore API

REST API architecture

JSON Request & responses

JWT Secure authentication

HTTPS Encrypted transport

01

Introduction

Everything you need to connect your application to Raynix.

The Raynix Property API provides a secure interface for authorised third-party systems to synchronise property information and associated media with Raynix.

Secure by design

API requests are protected using HTTPS and JWT bearer authentication.

Property synchronisation

Create and update property information directly from your platform.

Media management

Manage property images and video references through the API.

02

Authentication

Authenticate once and use the returned JWT token for subsequent API requests.

POST


                                /api/Auth/login

Authentication

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

Request

{
  "username": "YOUR_USERNAME",
  "password": "YOUR_PASSWORD"
}

Response

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

Never expose API credentials in client-side applications or public repositories.

03

Base URLs

Use the appropriate endpoint for each Raynix service.

AUTHENTICATION


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

PROPERTY API


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

04

Add Property

Create a new property listing with metadata and media.

POST


                                /api/ThirdPartyAgentIQ/AddProperty

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

Authorization


                                Bearer <JWT_TOKEN>

Content-Type


                                application/json

JSON Request

{
  "propertiesReferenceNumber": "000121",
  "title": "Modern 2-Bedroom Apartment",
  "flatNumber": "Flat 12",
  "address": "Greenview Estate, London",
  "price": 1500,
  "bedrooms": 2,
  "bathrooms": 1,
  "area": "850 sqft",
  "description": "A modern apartment.",
  "agentCode": "AGENT-GUID",
  "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",
  "media": [
    {
      "mediaId": "IMG-003",
      "type": "image",
      "url": "https://example.com/front.jpg",
      "fileName": "front.jpg"
    }
  ]
}

Success Response

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

05

Update Property

Update an existing property using its reference number.

PUT


                                /api/ThirdPartyAgentIQ/UpdateProperty

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

JSON Request

{
  "propertiesReferenceNumber": "000121",
  "title": "Modern 2-Bedroom Apartment",
  "price": 1600,
  "bedrooms": 2,
  "bathrooms": 1,
  "status": "RESERVED",
  "postCode": "E14 9AB",
  "isForRent": true,
  "isForSelling": false
}

200


                            Successful

06

Lock Property

Remove or lock a property using its reference number.

DELETE


                                /api/ThirdPartyAgentIQ/properties/{propertyReferenceNumber}

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

cURL

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

07

Reactivate Property

Reactivate a previously locked property.

PUT


                                /api/ThirdPartyAgentIQ/ReactivateProperty

JSON Request

{
  "propertiesReferenceNumber": "000121"
}

08

Lock Property Media

Lock a specific media item attached to a property.

DELETE


                                /properties/{propertyReferenceNumber}/media/{mediaId}

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

curl -X DELETE \
'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/000121/media/IMG-003' \
-H 'Authorization: Bearer <JWT_TOKEN>'

09

Reactivate Property Media

Reactivate a previously locked media item.

PUT


                                /api/ThirdPartyAgentIQ/ReactivatePropertyMedia

{
  "propertiesReferenceNumber": "000121",
  "mediaId": "IMG-003"
}

10

Property Status

Lifecycle states supported by the Property API.

Code Display Category

AVAILABLE_RENT Available for Rent Availability

AVAILABLE_SALE Available for Sale Availability

AVAILABLE_BOTH Available for Rent and Sale Availability

COMING_SOON Coming Soon Availability

VACANT Vacant Occupancy

OCCUPIED Occupied Occupancy

RESERVED Reserved Transaction

PENDING Pending Transaction

UNDER_CONTRACT Under Contract Transaction

OFFER_ACCEPTED Offer Accepted Transaction

SOLD Sold Finalized

RENTED Rented Finalized

LEASE_SIGNED Lease Signed Rental

NOTICE_GIVEN Notice Given Rental

UNDER_MAINTENANCE Under Maintenance Operations

RENOVATION Renovation Operations

INSPECTION Inspection Operations

REPAIR_REQUIRED Repair Required Operations

READY Ready for Occupancy Operations

WITHDRAWN Withdrawn Administrative

EXPIRED Expired Administrative

OFF_MARKET Off Market Administrative

11

Response Codes

Standard Raynix API response codes.

00

Successful

The request completed successfully.

01

Failed

The request could not be completed.

06

Validation Failed

One or more request fields failed validation.

09

Invalid Username

Authentication credentials could not be validated.

401

Unauthorized

The JWT token is missing, invalid or expired.

12

Property Data Model

Core fields accepted by property endpoints.

Field Type Description

propertiesReferenceNumber string

Unique property reference number.

title string

Property listing title.

address string

Full property address.

price number

Monthly rental price.

bedrooms number

Number of bedrooms.

bathrooms number

Number of bathrooms.

description string

Detailed property description.

agentCode GUID

Unique identifier for the assigned agent.

status string

Current property lifecycle status.

postCode string

Property postcode.

availableDate ISO 8601

Date when the property becomes available.

propertyType string

Residential or Commercial.

media array

Associated property media.

Build with Raynix.

Introduction

Secure by design

Property synchronisation

Media management

Authentication

Base URLs

Add Property

Update Property

Lock Property

Reactivate Property

Lock Property Media

Reactivate Property Media

Property Status

Response Codes

Property Data Model

Build your Raynix integration.