MENU navbar-image
Secure Stay
json

Introduction

Welcome to the Secure Stay platform API.

We are open to integrate with SecureStay to enroll and publish insurance policies to their customers in an automated way that aligns with their new customers during onboarding or promote to their existing customers profiles.

Each feature is designed to help our users more easily make changes on Secure Stay system while ensuring the best service experience.

This article on our Help Center details the recent changes and is designed to keep you continuously informed on any additions or updates to our API and API documentation.

Quick Start

You can use our API to get started, it will provide you with everything you need to integrate with us to gain insurance coverage or to enhance service offerings to your customers.

Default Base URL

The default base URL for Secure Stay API is: https://securestay.mypropertyprotect.com All data should be sent in JSON format and with a Content-Type: application/json header.

Base URL

https://securestay.mypropertyprotect.com/api

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by using the /login endpoint.

{
    email: '',
    password: ''
}

Policy

Add policy

requires authentication


     {
    "booking": {
        "checkin": "2021-11-26",
        "checkout": "2021-11-26",
        "plan": "excepturi",
        "source_id": "quidem"
    },
    "listing": {
        "name": "repudiandae",
        "address": "voluptatem",
        "state": "iusto",
        "city": "quo",
        "zip": "velit",
        "unit_number": "aspernatur"
    },
    "guest": {
        "first_name": "consequatur",
        "last_name": "repellat",
        "email": "quia",
        "phone": 11,
        "address": "sunt",
        "state": "expedita",
        "city": "reiciendis",
        "zip": 10
    },
    "host": {
        "first_name": "voluptatem",
        "last_name": "officiis",
        "email": "[email protected]",
        "phone": 8
    }
}

Request   

POST api/policy/add

Body Parameters

Parameter type format Description
booking.checkin string required

Must be a valid date in the format Y-m-d.

booking.checkout string required

Must be a valid date in the format Y-m-d.

booking.plan string required

'guard' is for $39 plan
'defense' is for $49 plan
'shield' is for $99 plan

booking.source_id string required

Unique ID of integrated application

listing.name string required Null
listing.address string required Null
listing.state string required Null
listing.city string required Null
listing.zip string required Null
listing.unit_number string optional Null
guest.first_name string required Null
guest.last_name string required Null
guest.email string required Null
guest.phone integer optional Null
guest.address string optional Null
guest.state string optional Null
guest.city string optional Null
guest.zip integer optional Null
host.first_name string required Null
host.last_name string required Null
host.email string required

Must be a valid email address.

host.phone integer optional Null

Details of policy.

requires authentication

Request   

GET api/policy/{policy_no}

URL Parameters

Parameter type format Description
policy_no string required

Policy Number

Update policy.

requires authentication


     {
    "checkin": "2021-11-26",
    "checkout": "2021-11-26",
    "guest_first_name": "nostrum",
    "guest_last_name": "dicta",
    "guest_address": "quasi",
    "guest_state": "non",
    "guest_city": "asperiores",
    "guest_zip": "repudiandae"
}

Request   

PUT api/policy/{policy_no}

URL Parameters

Parameter type format Description
policy_no string required

Policy Number

Body Parameters

Parameter type format Description
checkin string required

Must be a valid date in the format Y-m-d.

checkout string required

Must be a valid date in the format Y-m-d.

guest_first_name string required Null
guest_last_name string required Null
guest_address string optional Null
guest_state string optional Null
guest_city string optional Null
guest_zip string optional Null

Cancel policy.

requires authentication

Request   

GET api/policy/cancel/{policy_no}

URL Parameters

Parameter type format Description
policy_no string required

Policy Number

Delete policy.

requires authentication

Request   

DELETE api/policy/{policy_no}

URL Parameters

Parameter type format Description
policy_no string required

Policy Number