Waivers API

Endpoints for managing waiver templates, retrieving signed waivers, and configuring in-house waiver flows.

Waivers

Get waiver URL by location

GET /waiverUrl

Retrieves the waiver URL and logo URL for a given location ID

Parameters

Name	In	Type	Required	Description
`locationId`	query	string	Yes	The location ID to retrieve waiver URL for

Responses

Code	Description
`200`	Waiver URL and logo URL retrieved successfully
`400`	Invalid or missing locationId
`404`	Waiver URL not found for the provided locationId
`500`	Internal server error

Validate a waiver number

GET /waiverNumberValidation

Validates a waiver number (PIN) and returns the waiver details if found and pending

Parameters

Name	In	Type	Required	Description
`waiverNumber`	query	string	Yes	The waiver number (PIN) to validate
`locationId`	query	string	Yes	The location ID to validate the waiver against

Responses

Code	Description
`200`	Waiver number validated successfully
`400`	Invalid or missing waiverNumber or locationId
`404`	Waiver number not found or duplicate waiver numbers found
`500`	Internal server error

In-House Waivers

Get location logo

GET /inHouseWaiver/logo/{locationId}

Retrieves the logo URL for a specific location

Parameters

Name	In	Type	Required	Description
`locationId`	path	string	Yes	The location ID to retrieve the logo for

Responses

Code	Description
`200`	Logo URL retrieved successfully
`404`	Location not found
`500`	Failed to fetch location logo

List waiver templates by location

GET /inHouseWaiver/waiver/templates/location/{locationId}

Retrieves all waiver templates for a specific location ID

Parameters

Name	In	Type	Required	Description
`locationId`	path	string	Yes	The location ID to retrieve templates for
`fn`	query	string	No	First name (for tracking)
`ln`	query	string	No	Last name (for tracking)
`em`	query	string	No	Email (for tracking)

Responses

Code	Description
`200`	List of waiver templates
`500`	Failed to fetch waiver templates by location

Create a waiver template

POST /inHouseWaiver/waiver/template

Creates a new waiver template. Requires authentication.

Request body

Field	Type	Required
`title`	string	Yes
`description`	string	No
`sections`	array	Yes
`customerId`	string	Yes
`locationId`	string	Yes
`assignTo`	array	No

Responses

Code	Description
`201`	Template created successfully
`403`	Unauthorized to create this waiver template
`500`	Failed to create waiver template

Get a waiver template by ID

GET /inHouseWaiver/waiver/template/{templateId}

Retrieves a specific waiver template by its template ID

Parameters

Name	In	Type	Required	Description
`templateId`	path	string	Yes	The template ID to retrieve

Responses

Code	Description
`200`	Waiver template retrieved successfully
`404`	Waiver template not found
`500`	Failed to fetch waiver template

Update a waiver template

PUT /inHouseWaiver/waiver/template/{templateId}

Updates an existing waiver template. Requires authentication.

Parameters

Name	In	Type	Required	Description
`templateId`	path	string	Yes	The template ID to update

Request body

Field	Type	Required
`title`	string	No
`description`	string	No
`sections`	array	No
`customerId`	string	Yes
`locationId`	string	No
`assignTo`	array	No

Responses

Code	Description
`200`	Template updated successfully
`403`	Unauthorized to update this waiver template
`404`	Waiver template not found
`500`	Failed to update waiver template

Delete a waiver template

DELETE /inHouseWaiver/waiver/template/{templateId}

Deletes a waiver template. Requires authentication.

Parameters

Name	In	Type	Required	Description
`templateId`	path	string	Yes	The template ID to delete

Responses

Code	Description
`200`	Template deleted successfully
`403`	Unauthorized to delete this waiver template
`404`	Waiver template not found
`500`	Failed to delete waiver template

List all waiver templates

GET /inHouseWaiver/waiver/templates

Lists all waiver templates for the authenticated user's customer. Requires authentication.

Parameters

Name	In	Type	Required	Description
`locationId`	query	string	Yes	The location ID to filter templates by

Responses

Code	Description
`200`	List of waiver templates
`400`	Location ID is required
`500`	Failed to list waiver templates

Sign a waiver

POST /inHouseWaiver/waiver/sign

Signs a waiver internally with form data, generates a PDF, and stores the signature record

Request body

Field	Type	Required	Description
`templateId`	string	Yes	The waiver template ID to sign
`firstName`	string	Yes
`lastName`	string	Yes
`dob`	string	No	Date of birth
`userEmail`	string	No
`phoneNumber`	string	No
`addressLine`	string	No
`formData`	object	Yes	Form responses including signatures as base64 data URLs
`ipAddress`	string	No
`userAgent`	string	No
`waiverNumber`	string	No
`transactionId`	string	No
`tid`	string	No
`bookingData`	object	No
`assignTo`	string	No

Responses

Code	Description
`201`	Waiver signed successfully
`404`	Waiver template not found
`409`	Signature ID already exists (duplicate submission)
`500`	Failed to sign waiver

Get a signed waiver by ID

GET /inHouseWaiver/waiver/sign/{signatureId}

Retrieves a signed waiver record by its signature ID

Parameters

Name	In	Type	Required	Description
`signatureId`	path	string	Yes	The signature ID to retrieve

Responses

Code	Description
`200`	Signed waiver retrieved successfully
`404`	Signed waiver not found
`500`	Failed to fetch signed waiver

Get waiver signature info

GET /inHouseWaiver/waiver/sign/info/{signatureId}

Returns collected information about a signed waiver

Parameters

Name	In	Type	Required	Description
`signatureId`	path	string	Yes	The signature ID to get info for

Responses

Code	Description
`200`	Waiver info retrieved successfully
`404`	Signed waiver not found
`500`	Failed to fetch waiver info

Verify waiver status

GET /inHouseWaiver/waiver/verify/{signatureId}

Verifies the status of a signed waiver including PDF existence and transaction update status

Parameters

Name	In	Type	Required	Description
`signatureId`	path	string	Yes	The signature ID to verify

Responses

Code	Description
`200`	Waiver status verified
`404`	Waiver signature not found
`500`	Failed to verify waiver status

Waivers .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Get waiver URL by location .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Validate a waiver number .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

In-House Waivers .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Get location logo .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

List waiver templates by location .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Create a waiver template .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Get a waiver template by ID .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Update a waiver template .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Delete a waiver template .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

List all waiver templates .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Sign a waiver .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Get a signed waiver by ID .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Get waiver signature info .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Verify waiver status .docs-heading:hover .heading-anchor { opacity: 1; } .heading-anchor:focus { opacity: 1; }

Waivers

Get waiver URL by location

Validate a waiver number

In-House Waivers

Get location logo

List waiver templates by location

Create a waiver template

Get a waiver template by ID

Update a waiver template

Delete a waiver template

List all waiver templates

Sign a waiver

Get a signed waiver by ID

Get waiver signature info

Verify waiver status