openapi: 3.0.3
info:
    title: 'Smartwaiver API Docs'
    description: ''
    version: 1.0.0
servers:
    -
        url: 'https://api.smartwaiver.com'
paths:
    /ping:
        get:
            summary: Ping
            description: 'Ping/Pong Test'
            parameters:
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: ''
                    content:
                        text/plain:
                            schema:
                                type: string
                                example: pong
            tags:
                - 'Api Info'
            security: []
    /version:
        get:
            summary: "Version\nApi Version Information"
            description: ''
            parameters:
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: ''
                    content:
                        text/plain:
                            schema:
                                type: string
                                example: 5.0.0
            tags:
                - 'Api Info'
            security: []
    /v4/checkins:
        get:
            summary: "List checkins for waivers\nList checkins for waivers"
            description: ''
            parameters:
                -
                    in: query
                    name: checkinId
                    description: 'The specific checkin record you would like to get data from.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'The specific checkin record you would like to get data from.'
                        example: null
                -
                    in: query
                    name: waiverId
                    description: 'The specific waiver you would like to get data from. A waiver can have multiple checkins if it has multiple signers'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'The specific waiver you would like to get data from. A waiver can have multiple checkins if it has multiple signers'
                        example: null
                -
                    in: query
                    name: fromDts
                    description: 'Limit to checkins after this ISO 8601 date (Must not be within the current hour) (If not provided time will default to 00:00:00). Allowed values: Must be in ISO 8601 format'
                    example: '2018-01-01'
                    required: true
                    schema:
                        type: string
                        description: 'Limit to checkins after this ISO 8601 date (Must not be within the current hour) (If not provided time will default to 00:00:00). Allowed values: Must be in ISO 8601 format'
                        example: '2018-01-01'
                -
                    in: query
                    name: toDts
                    description: 'End date of checkin report (must be before current hour) (ISO in UTC)'
                    example: '2018-01-02'
                    required: true
                    schema:
                        type: string
                        description: 'End date of checkin report (must be before current hour) (ISO in UTC)'
                        example: '2018-01-02'
                -
                    in: query
                    name: limit
                    description: 'Limit to this number of checkins. Default value: 20 Allowed values: 1-100'
                    example: null
                    required: false
                    schema:
                        type: integer
                        description: 'Limit to this number of checkins. Default value: 20 Allowed values: 1-100'
                        example: null
                -
                    in: query
                    name: offset
                    description: 'Offset to be combined with limit to page results. Default value: 0 Allowed values 0-1000'
                    example: null
                    required: false
                    schema:
                        type: integer
                        description: 'Offset to be combined with limit to page results. Default value: 0 Allowed values 0-1000'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        text/plain:
                            schema:
                                type: string
                                example: "{\n    \"version\": 4,\n    \"id\": \"a0256461ca244278b412ab3238f5efd2\",\n    \"ts\": \"2024-05-20T20:09:53+00:00\",\n    \"type\": \"checkins\",\n    \"checkins\": {\n        \"fromDts\": \"2018-01-01\",\n        \"toDts\": \"2018-01-02\",\n        \"moreCheckins\": false,\n        \"checkins\": [\n            {\n                \"checkinId\": 12345,\n                \"date\": \"2018-01-01 12:32:16\",\n                \"waiverId\": \"56461ca244278b412ab3\",\n                \"position\": 0,\n                \"firstName\": \"John\",\n                \"lastName\": \"Doe\",\n                \"isMinor\": false,\n                \"dateSigned\": \"2018-01-02 12:32:16\"\n                \"templateId\": 12345\n            }\n        ]\n    }\n}"
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (checkins)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (checkins)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
            tags:
                - Checkins
    /v4/dynamic/templates:
        post:
            summary: 'Create a dynamic template for your customer to fill out'
            description: "Use this route to create a dynamic template for your customer to sign. This route is very similar to the functionality provided in our JS library here. We recommend using the JS library to create your dynamic templates.\n### Need your Smartwaiver Published Key?\n<a href=\"https://app.smartwaiver.com/user/api/published-keys\">Create Your Published Key</a>\nYour published key is a token that publicly identifies your account.\nTHIS IS NOT YOUR API KEY.\nNever publish your API Key to your website.\n\n### Versions\n\n- Smartwaiver JS 1.0.0 <a href=\"https://js-lib.smartwaiver.com/sw-js-1.0.js\">minified</a>\n\n### Example Usage\n\nIt's easy to get started!\nJust simply add our Javscript library to your page and then you can use the Smartwaiver object.\n\n```\n<script src=\"https://js-lib.smartwaiver.com/sw-js-1.0.js\"></script>\n<script>\n    smartwaiver.templates.dynamic({\n        \"publishedKey\": \"{{env('SMARTWAIVER_PUBLISHED_KEY')}}\",\n        \"mode\": \"redirect\",\n        \"expiration\": 300,\n        .\n        .\n        .\n\n\n\n```\n\n### API Documentation\n\nCreating a dynamic template for your customer to sign is just the first step!\nNext you'll want to request processing of that document and retrieve their information after they have signed it."
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: dynamic
                                    dynamic: { url: 'https://waiver.smartwaiver.com/d/fDopTNTw5Zq8bCQnijBXuf/', uuid: fDopTNTw5Zq8bCQnijBXuf, expiration: 300 }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: dynamic, description: 'Type of response given (dynamic)' }
                                    dynamic: { type: object, example: { url: 'https://waiver.smartwaiver.com/d/fDopTNTw5Zq8bCQnijBXuf/', uuid: fDopTNTw5Zq8bCQnijBXuf, expiration: 300 }, description: 'Signed waiver information' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (dynamic)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                406:
                    description: '406, Wrong Content Type'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Content-Type must be json'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (dynamic)' }
                                    message: { type: string, example: 'Content-Type must be json' }
            tags:
                - 'Dynamic Waivers'
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                dynamic:
                                    type: object
                                    description: 'Root Object.'
                                    example: null
                                    properties: []
                                template:
                                    type: string
                                    description: 'See <a href="https://api.smartwaiver.com/docs/js/">JS Docs</a> for template parameters.'
                                    example: null
                                data:
                                    type: string
                                    description: 'See <a href="https://api.smartwaiver.com/docs/js/">JS Docs</a> for template parameters.'
                                    example: null
                            required:
                                - dynamic
                                - template
                                - data
    '/v4/dynamic/process/{transactionId}':
        post:
            summary: 'Request processing of a signed dynamic waiver'
            description: "Use this route to request processing of your dynamic waivers. Wondering how you create and submit dynamic waivers. Check out the documentation for our JS library here\n\nTransaction Id Example ->\n```\n\"completion\": {\n\n    \"redirect\": {\n\n        \"success\": \"https://www.example.org/?transactionId=[transactionId]&bookingId=123456\",\n\n        \"cancel\": \"https://www.example.com\"\n\n    }\n\n}\n```\nSee <a href=\"https://api.smartwaiver.com/docs/js/\">JS Docs</a> for data parameters."
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: dynamic_process
                                    dynamic_process: { waiverId: HK8L6Yaq2s2Bu8UMcBEo, transactionId: UMcBEoyTvDeizmj94p6 }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: dynamic_process, description: 'Type of response given (dynamic_process)' }
                                    dynamic_process: { type: object, example: { waiverId: HK8L6Yaq2s2Bu8UMcBEo, transactionId: UMcBEoyTvDeizmj94p6 }, description: 'Signed waiver information' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (dynamic_process)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (dynamic_process)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - 'Dynamic Waivers'
        parameters:
            -
                in: path
                name: transactionId
                description: 'API key for the account. The transaction ID returned via query string param in redirect URL after the customer signs your waiver. See above for more details'
                example: TRANSACTION_ID
                required: true
                schema:
                    type: string
    /v4/keys/published:
        get:
            summary: "List Published Keys\nList your published keys"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: published_keys
                                    published_keys: { keys: [{ createdAt: '2024-05-20T20:09:53+00:00', key: SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6, label: demo }] }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: published_keys, description: 'Type of response given (published_keys)' }
                                    published_keys: { type: object, example: { keys: [{ createdAt: '2024-05-20T20:09:53+00:00', key: SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6, label: demo }] }, description: 'Published Keys Object' }
            tags:
                - Keys
        post:
            summary: "Create Published Key\nCreate a new published key"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: published_keys
                                    published_keys: { newKey: { createdAt: '2024-05-20T20:09:53+00:00', key: SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6, label: demo }, keys: [{ createdAt: '2024-05-20T20:09:53+00:00', key: SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6, label: demo }] }
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00' }
                                    type: { type: string, example: published_keys, description: 'Type of response given (published_keys)' }
                                    published_keys: { type: object, example: { newKey: { createdAt: '2024-05-20T20:09:53+00:00', key: SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6, label: demo }, keys: [{ createdAt: '2024-05-20T20:09:53+00:00', key: SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6, label: demo }] }, description: 'Published Keys Object' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (published_keys)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00' }
                                    type: { type: string, example: data_error, description: 'Type of response given (published_keys)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                406:
                    description: '406, Conflict Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Label is already in use. Please choose another label.'
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00' }
                                    type: { type: string, example: error, description: 'Type of response given (published_keys)' }
                                    message: { type: string, example: 'Label is already in use. Please choose another label.' }
            tags:
                - Keys
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                label:
                                    type: string
                                    description: 'API key for account.'
                                    example: demo
                            required:
                                - label
    /v4/sms:
        post:
            summary: "Send SMS\nThis API is rate limited by day for security purposes and to prevent spam. By default, the rate limit allows only a few SMS messages to be sent per day. You can request an increase by contacting our support team."
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: f3f29234b1e34e2ab9122c309c9e0e47
                                    ts: '2023-10-11T19:35:10+00:00'
                                    type: sms
                                    sms: { id: SM449100294d129ca4a377f3f217f89d5e, phone: '+1 555-555-5555', template: { uuid: ckbtnsjnje122vbtms2mt, title: 'Test Example' }, status: 1, date: '2023-10-11 19:35:11' }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: f3f29234b1e34e2ab9122c309c9e0e47, description: 'Unique ID of SMS message' }
                                    ts: { type: string, example: '2023-10-11T19:35:10+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: sms, description: 'Type of response given (sms)' }
                                    sms: { type: object, example: { id: SM449100294d129ca4a377f3f217f89d5e, phone: '+1 555-555-5555', template: { uuid: ckbtnsjnje122vbtms2mt, title: 'Test Example' }, status: 1, date: '2023-10-11 19:35:11' }, description: '' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Unique ID of SMS message' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (sms)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Unique ID of SMS message' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (sms)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
            tags:
                - SMS
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                templateId:
                                    type: string
                                    description: 'The Id of the waiver template you would like to send'
                                    example: TEMPLATE_ID
                                number:
                                    type: integer
                                    description: 'The phone number you would like to send the waiver to.'
                                    example: 0
                            required:
                                - templateId
                                - number
    /v4/search:
        get:
            summary: 'Request a search for signed waivers'
            description: "This search route will conduct a synchronous search and then return a GUID that can be used to access all results from the search. If the search returns zero results a valid GUID will be returned but since no pages exist for that GUID all requests for results will return an error.\nIf the search result set is large the request can take up to several seconds, so make sure your timeouts are set correctly.\nNote: The returned search GUID will expire after 12 hours.\n\nNote: The search is currently limited to `30,000` results.\n\nNote: This request is not included in the normal 100 request per minute limit, but is instead limited to 5 requests per minute by itself."
            parameters:
                -
                    in: query
                    name: templateId
                    description: 'Limit to waivers of the given waiver template ID.'
                    example: 6jebdfxzvrdkd
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers of the given waiver template ID.'
                        example: 6jebdfxzvrdkd
                -
                    in: query
                    name: fromDts
                    description: 'Limit to waivers after this ISO 8601 date. Allowed values: `Must be in ISO 8601 format`'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers after this ISO 8601 date. Allowed values: `Must be in ISO 8601 format`'
                        example: null
                -
                    in: query
                    name: toDts
                    description: 'Limit to waivers before this ISO 8601 date. Allowed values: `Must be in ISO 8601 format`'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers before this ISO 8601 date. Allowed values: `Must be in ISO 8601 format`'
                        example: null
                -
                    in: query
                    name: firstName
                    description: 'Limit to waivers with any participant having this for a first name (Case Insensitive).'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with any participant having this for a first name (Case Insensitive).'
                        example: null
                -
                    in: query
                    name: lastName
                    description: 'Limit to waivers with any participant having this for a last name (Case Insensitive).'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with any participant having this for a last name (Case Insensitive).'
                        example: null
                -
                    in: query
                    name: email
                    description: 'Limit to waivers with any participant having this email address.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with any participant having this email address.'
                        example: null
                -
                    in: query
                    name: verified
                    description: 'Limit selection to waiver that have been verified or not. Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit selection to waiver that have been verified or not. Allowed values: true, false.'
                        example: null
                -
                    in: query
                    name: sort
                    description: 'Return search results in descending (latest first) or ascending (earliest first) order. Default value: desc. Allowed values: desc, asc'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Return search results in descending (latest first) or ascending (earliest first) order. Default value: desc. Allowed values: desc, asc'
                        example: null
                -
                    in: query
                    name: tag
                    description: 'Limit to waivers with a participant having this as their primary tag'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with a participant having this as their primary tag'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2017-01-24T11:14:25+00:00'
                                    type: search
                                    search: { guid: 6jebdfxzvrdkd, count: 652, pages: 7, pageSize: 100 }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2017-01-24T11:14:25+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: search, description: 'Type of response given (search)' }
                                    search: { type: object, example: { guid: 6jebdfxzvrdkd, count: 652, pages: 7, pageSize: 100 }, description: 'Signed waiver information' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (search)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (search)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
            tags:
                - Search
    '/v4/search/{guid}/results':
        get:
            summary: 'Retrieve a page of search results'
            description: "Use this route to retrieve each page of the search results from the above route. If a page outside the results is requested a 402 error will be returned with an appropriate message.\n\nNote: The GUID from the search route will expire after 12 hours.\n\n\nNote: *The pagination uses a zero-based index.* So to query all results start with ?page=0\n\nNote: This request can be quite slow to retrieve the page. However, due to our caching mechanism, subsequent requests for the same page will be significantly faster."
            parameters:
                -
                    in: query
                    name: page
                    description: 'Which page of the search results you want to return. Note: pages use a zero-based index'
                    example: null
                    required: true
                    schema:
                        type: integer
                        description: 'Which page of the search results you want to return. Note: pages use a zero-based index'
                        example: null
                -
                    in: query
                    name: pdf
                    description: 'Include Base 64 encoded PDF of signed waiver Default value: false Allowed values: true, false'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Include Base 64 encoded PDF of signed waiver Default value: false Allowed values: true, false'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2017-01-24T11:14:25+00:00'
                                    type: search_results
                                    search_results: [{ waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', expirationDate: '', expired: false, verified: true, kiosk: true, firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', autoTag: '', clientIP: 192.0.2.0, email: example@smartwaiver.com, marketingAllowed: false, addressLineOne: '626 NW Arizona Ave.', addressLineTwo: 'Suite 2', addressCity: Bend, addressState: OR, addressZip: '97703', addressCountry: US, emergencyContactName: 'Mary Smith', emergencyContactPhone: 111-111-1111, insuranceCarrier: 'My Insurance', insurancePolicyNumber: '1234567', driversLicenseNumber: '9876543', driversLicenseState: OR, tags: ['Green Team'], flags: [{ displayText: 'Have you received our orientation?', reason: 'was not selected' }], participants: [{ firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', isMinor: true, gender: Male, phone: '', tags: ['YES'], customParticipantFields: { bk3xydss4e9dy: { value: 'YES', displayText: 'Is this participant ready to have fun?' } }, flags: [{ displayText: 'Are you excited?', reason: 'was not selected' }] }], pdf: 'Base64 Encoded PDF', photos: 1, guardian: { firstName: Kyle, middleName: '', lastName: 'Smith I', phone: 555-555-5555, dob: '1970-12-25' }, customWaiverFields: { ha5bs1jy5wdop: { value: 'A friend', displayText: 'How did you hear about Smartwaiver?' } } }]
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2017-01-24T11:14:25+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: search_results, description: 'Type of response given (search_results)' }
                                    search_results: { type: array, example: [{ waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', expirationDate: '', expired: false, verified: true, kiosk: true, firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', autoTag: '', clientIP: 192.0.2.0, email: example@smartwaiver.com, marketingAllowed: false, addressLineOne: '626 NW Arizona Ave.', addressLineTwo: 'Suite 2', addressCity: Bend, addressState: OR, addressZip: '97703', addressCountry: US, emergencyContactName: 'Mary Smith', emergencyContactPhone: 111-111-1111, insuranceCarrier: 'My Insurance', insurancePolicyNumber: '1234567', driversLicenseNumber: '9876543', driversLicenseState: OR, tags: ['Green Team'], flags: [{ displayText: 'Have you received our orientation?', reason: 'was not selected' }], participants: [{ firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', isMinor: true, gender: Male, phone: '', tags: ['YES'], customParticipantFields: { bk3xydss4e9dy: { value: 'YES', displayText: 'Is this participant ready to have fun?' } }, flags: [{ displayText: 'Are you excited?', reason: 'was not selected' }] }], pdf: 'Base64 Encoded PDF', photos: 1, guardian: { firstName: Kyle, middleName: '', lastName: 'Smith I', phone: 555-555-5555, dob: '1970-12-25' }, customWaiverFields: { ha5bs1jy5wdop: { value: 'A friend', displayText: 'How did you hear about Smartwaiver?' } } }], description: 'Signed waiver information', items: { type: object } }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (search_results)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (search_results)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (search_results)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Search
        parameters:
            -
                in: path
                name: guid
                description: 'The guid of the search results returned from the search request.'
                example: 6jebdfxzvrdkd
                required: true
                schema:
                    type: string
    /v4/templates:
        get:
            summary: "List waiver templates\nList waiver templates"
            description: ''
            parameters:
                -
                    in: query
                    name: customFields
                    description: 'Include custom field data in the response Default value: false Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Include custom field data in the response Default value: false Allowed values: true, false.'
                        example: null
                -
                    in: query
                    name: published
                    description: 'Limit to only published waivers. Default value: false Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to only published waivers. Default value: false Allowed values: true, false.'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: templates
                                    templates: [{ templateId: sprswrvh2keeh, title: 'Demo Waiver', publishedVersion: 78015, publishedOn: '2016-11-02T21:18:38+00:00', webUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/web/', kioskUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/kiosk/', vanityUrls: ['https://waiver.smartwaiver.com/v/foo/', 'https://waiver.smartwaiver.com/v/bar/'], webhook: { endpoint: 'https://www.example.org/foo/', emailValidationRequired: 'yes' }, customFields: [{ guid: 5RT5Zfn4yjLFrcvgSyZQnX, fieldType: textbox, type: string, label: 'The Texbox' }], customParticipantFields: [{ guid: adztfQsYTPmQhLR1cTcJyZ, fieldType: optionlist, type: array, label: 'The Checkboxes' }] }]
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: templates, description: 'Type of response given (templates)' }
                                    templates: { type: array, example: [{ templateId: sprswrvh2keeh, title: 'Demo Waiver', publishedVersion: 78015, publishedOn: '2016-11-02T21:18:38+00:00', webUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/web/', kioskUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/kiosk/', vanityUrls: ['https://waiver.smartwaiver.com/v/foo/', 'https://waiver.smartwaiver.com/v/bar/'], webhook: { endpoint: 'https://www.example.org/foo/', emailValidationRequired: 'yes' }, customFields: [{ guid: 5RT5Zfn4yjLFrcvgSyZQnX, fieldType: textbox, type: string, label: 'The Texbox' }], customParticipantFields: [{ guid: adztfQsYTPmQhLR1cTcJyZ, fieldType: optionlist, type: array, label: 'The Checkboxes' }] }], description: 'Waiver template information', items: { type: object } }
            tags:
                - Templates
    '/v4/templates/{templateId}':
        get:
            summary: "Retrieve a waiver template\nRetrieve a waiver template"
            description: ''
            parameters:
                -
                    in: query
                    name: customFields
                    description: 'Include custom field data in the response Default value: false Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Include custom field data in the response Default value: false Allowed values: true, false.'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: template
                                    template: { templateId: sprswrvh2keeh, title: 'Demo Waiver', publishedVersion: 78015, publishedOn: '2016-11-02T21:18:38Z', webUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/web/', kioskUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/kiosk/', vanityUrls: ['https://waiver.smartwaiver.com/v/foo/', 'https://waiver.smartwaiver.com/v/bar/'], webhook: { endpoint: 'https://www.example.org/foo/', emailValidationRequired: 'yes' }, customFields: [{ guid: 5RT5Zfn4yjLFrcvgSyZQnX, fieldType: textbox, type: string, label: 'The Texbox' }], customParticipantFields: [{ guid: adztfQsYTPmQhLR1cTcJyZ, fieldType: optionlist, type: array, label: 'The Checkboxes' }] }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: template, description: 'Type of response given (template)' }
                                    template: { type: object, example: { templateId: sprswrvh2keeh, title: 'Demo Waiver', publishedVersion: 78015, publishedOn: '2016-11-02T21:18:38Z', webUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/web/', kioskUrl: 'https://www.smartwaiver.com/w/sprswrvh2keeh/kiosk/', vanityUrls: ['https://waiver.smartwaiver.com/v/foo/', 'https://waiver.smartwaiver.com/v/bar/'], webhook: { endpoint: 'https://www.example.org/foo/', emailValidationRequired: 'yes' }, customFields: [{ guid: 5RT5Zfn4yjLFrcvgSyZQnX, fieldType: textbox, type: string, label: 'The Texbox' }], customParticipantFields: [{ guid: adztfQsYTPmQhLR1cTcJyZ, fieldType: optionlist, type: array, label: 'The Checkboxes' }] }, description: 'Waiver template information' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (template)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
            tags:
                - Templates
        parameters:
            -
                in: path
                name: templateId
                description: 'Unique ID of waiver template'
                example: TEMPLATE_ID
                required: true
                schema:
                    type: string
    '/v4/templates/{templateId}/prefill':
        post:
            summary: "Prefill a waiver template\nPrefill a waiver template"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: prefill
                                    prefill: { uuid: a0256461ca244278b4, expiration: 30000, url: 'https://waiver.smartwaiver.com/p/a0256461ca244278b4/' }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: prefill, description: 'Type of response given (prefill)' }
                                    prefill: { type: object, example: { uuid: a0256461ca244278b4, expiration: 30000, url: 'https://waiver.smartwaiver.com/p/a0256461ca244278b4/' }, description: 'Waiver template information' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (prefill)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Templates
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                expiration:
                                    type: integer
                                    description: 'Expiration in seconds of waiver template (Min: 300, Max: 2592000)'
                                    example: 30000
                                lockdownPrefill:
                                    type: boolean
                                    description: 'If set will not let users change prefill values on the waiver (Default: false)'
                                    example: false
                                kiosk:
                                    type: boolean
                                    description: 'Whether to use kiosk mode (Allowed types: true or false)'
                                    example: null
                                adult:
                                    type: boolean
                                    description: 'Weather the waiver has only an adult or also a child(Allowed types: true or false)'
                                    example: false
                                anyoneElseHidden:
                                    type: boolean
                                    description: 'Hide the anyone else need to sign buttons (Allowed types: true or false), (Default: false)'
                                    example: null
                                participants:
                                    type: array
                                    description: ''
                                    example: null
                                    items: { type: object, properties: { firstName: { type: string, description: 'The participant''s first name', example: John }, middleName: { type: string, description: 'The participant''s middle name', example: null }, lastName: { type: string, description: 'The participant''s last name', example: Doe }, phone: { type: string, description: 'The participant''s phone number', example: 555-555-5555 }, gender: { type: string, description: 'The participant''s gender', example: null }, dob: { type: string, description: 'The participant''s DOB (IS0 8601 formatting: e.g. 2000-01-01)', example: '2018-03-03' }, customFields: { type: object, description: 'The participant''s custom waiver fields', example: { aNk49uHsNjSezQbNVejRTr: 'Per Person Prefill Data' }, properties: { '{GUID}': { type: string, description: 'The participant''s custom waiver fields', example: null } } } } }
                                guardian:
                                    type: object
                                    description: ''
                                    example: null
                                    properties: { participant: { type: boolean, description: 'Whether the guardian is a participant or not (Default value: false)', example: null }, firstName: { type: string, description: 'The guardian''s first name', example: Jacob }, middleName: { type: string, description: 'The guardian''s middle name', example: null }, lastName: { type: string, description: 'The guardian''s last name', example: Doe }, relationship: { type: string, description: 'The guardian''s relationship to the minor', example: null }, phone: { type: string, description: 'The guardian''s phone number (if they are a participant)', example: null }, gender: { type: string, description: 'The guardian''s gender (if they are a participant)', example: null }, dob: { type: string, description: 'The guardian''s dob (IS0 8601 formatting: e.g. 2000-01-01)', example: '1999-03-03' }, customFields: { type: object, description: 'The participant''s custom waiver fields', example: { aNk49uHsNjSezQbNVejRTr: 'Guardian Prefill Data' }, properties: { '{GUID}': { type: string, description: 'The participant''s custom waiver fields', example: null } } } }
                                addressLineOne:
                                    type: string
                                    description: 'Address waiver question Line One'
                                    example: '123 Sesame Street'
                                addressLineTwo:
                                    type: string
                                    description: 'Address waiver question Line Two'
                                    example: null
                                addressCountry:
                                    type: string
                                    description: 'Address waiver question country'
                                    example: null
                                addressCity:
                                    type: string
                                    description: 'Address waiver question city'
                                    example: 'Ocean City'
                                addressState:
                                    type: string
                                    description: 'Address waiver question state'
                                    example: NJ
                                addressZip:
                                    type: string
                                    description: 'Address waiver question zip code'
                                    example: '12345'
                                email:
                                    type: string
                                    description: 'Email waiver question'
                                    example: example@test.com
                                emergencyContactName:
                                    type: string
                                    description: 'Emergency waiver question full name'
                                    example: null
                                emergencyContactFirstName:
                                    type: string
                                    description: 'Emergency waiver question first name'
                                    example: null
                                emergencyContactLastName:
                                    type: string
                                    description: 'Emergency waiver question last name'
                                    example: null
                                emergencyContactRelation:
                                    type: string
                                    description: 'Emergency waiver question relationship'
                                    example: null
                                emergencyContactPhone:
                                    type: string
                                    description: 'Emergency waiver question phone'
                                    example: null
                                insuranceCarrier:
                                    type: string
                                    description: 'Insurance carrier'
                                    example: null
                                insurancePolicyNumber:
                                    type: string
                                    description: 'Policy number'
                                    example: null
                                driversLicenseState:
                                    type: string
                                    description: 'Drivers License State'
                                    example: null
                                driversLicenseNumber:
                                    type: string
                                    description: 'Drivers License Number'
                                    example: null
                                customWaiverFields:
                                    type: object
                                    description: 'Custom waiver fields on the waiver'
                                    example: { fLX6DN4mWThQQoY5sKStDo: 'Per Waiver Prefill Data' }
                                    properties: { '{GUID}': { type: string, description: 'The value of the custom waiver field', example: null } }
                            required:
                                - expiration
        parameters:
            -
                in: path
                name: templateId
                description: 'Unique ID of waiver template'
                example: 9yskfhh4d9xkirqwgkux2b
                required: true
                schema:
                    type: string
    /v4/info:
        get:
            summary: 'Get User Basic Info'
            description: 'Lists the users basic info.'
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                401:
                    description: ''
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: 237c5e1617644afb8ec31b3531f6fad3
                                    ts: '2025-02-27T19:25:14+00:00'
                                    type: auth_error
                                    message: Unauthorized
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: 237c5e1617644afb8ec31b3531f6fad3, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2025-02-27T19:25:14+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: auth_error, description: 'Type of response given (info)' }
                                    message: { type: string, example: Unauthorized }
            tags:
                - User
    /v4/settings:
        get:
            summary: 'List User Settings'
            description: 'Lists the user settings.'
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                401:
                    description: ''
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: e6a958615e76411c90fc8bfe3500c815
                                    ts: '2025-02-27T19:25:14+00:00'
                                    type: auth_error
                                    message: Unauthorized
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: e6a958615e76411c90fc8bfe3500c815, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2025-02-27T19:25:14+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: auth_error, description: 'Type of response given (settings)' }
                                    message: { type: string, example: Unauthorized }
            tags:
                - User
    /v4/me:
        get:
            summary: 'Get Api Key Label'
            description: 'Gets the api key label of the current user.'
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                401:
                    description: ''
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: ec7899277b6d49f2bf049dede72910c0
                                    ts: '2025-02-27T19:25:14+00:00'
                                    type: auth_error
                                    message: Unauthorized
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: ec7899277b6d49f2bf049dede72910c0, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2025-02-27T19:25:14+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: auth_error, description: 'Type of response given (me)' }
                                    message: { type: string, example: Unauthorized }
            tags:
                - User
    /v4/waivers:
        get:
            summary: "List Signed Waivers\nList Signed Waivers"
            description: ''
            parameters:
                -
                    in: query
                    name: limit
                    description: 'Max number of waivers to return Default value: 20 Allowed values: 1-300.'
                    example: 5
                    required: false
                    schema:
                        type: integer
                        description: 'Max number of waivers to return Default value: 20 Allowed values: 1-300.'
                        example: 5
                -
                    in: query
                    name: offset
                    description: 'How many pages to paginate through. Based on the limit. So if limit is 300. Offsets to Waivers 301 - 600 Default value: 0'
                    example: 7
                    required: false
                    schema:
                        type: integer
                        description: 'How many pages to paginate through. Based on the limit. So if limit is 300. Offsets to Waivers 301 - 600 Default value: 0'
                        example: 7
                -
                    in: query
                    name: verified
                    description: 'Limit selection to waiver that have been verified or not Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit selection to waiver that have been verified or not Allowed values: true, false.'
                        example: null
                -
                    in: query
                    name: eventData
                    description: 'Include event data in the response Default value: false Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Include event data in the response Default value: false Allowed values: true, false.'
                        example: null
                -
                    in: query
                    name: templateId
                    description: 'Limit selection to signed waivers of the given template ID'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit selection to signed waivers of the given template ID'
                        example: null
                -
                    in: query
                    name: prefillId
                    description: 'Limit selection to signed waivers of the given prefill ID'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit selection to signed waivers of the given prefill ID'
                        example: null
                -
                    in: query
                    name: fromDts
                    description: 'Limit to checkins after this ISO 8601 date (Must not be within the current hour) (If not provided time will default to 00:00:00). Allowed values: Must be in ISO 8601 format'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to checkins after this ISO 8601 date (Must not be within the current hour) (If not provided time will default to 00:00:00). Allowed values: Must be in ISO 8601 format'
                        example: null
                -
                    in: query
                    name: toDts
                    description: 'End date of checkin report (must be before current hour) (ISO in UTC)'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'End date of checkin report (must be before current hour) (ISO in UTC)'
                        example: null
                -
                    in: query
                    name: firstName
                    description: 'Limit to waivers with a participant having this First Name (Case Insensitive)'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with a participant having this First Name (Case Insensitive)'
                        example: null
                -
                    in: query
                    name: lastName
                    description: 'Limit to waivers with a participant having this Last Name (Case Insensitive)'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with a participant having this Last Name (Case Insensitive)'
                        example: null
                -
                    in: query
                    name: tag
                    description: 'Limit to waivers with a participant having this as their primary tag'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Limit to waivers with a participant having this as their primary tag'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: waivers
                                    waivers: [{ waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Demo Waiver', createdOn: '2017-01-24 13:12:29', expirationDate: '', expired: false, verified: true, kiosk: true, firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', isMinor: true, autoTag: '', tags: ['Green Team'], flags: [{ displayText: 'Have you received our orientation?', reason: 'was not selected' }], events: [{ eventUuid: 5RT5Zfn4yjLFrcvgSyZQnX, name: 'Event Name', startDate: '2025-01-26 00:00:00', endDate: '2025-01-30 00:00:00' }] }]
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: waivers, description: 'Type of response given (waivers)' }
                                    waivers: { type: array, example: [{ waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Demo Waiver', createdOn: '2017-01-24 13:12:29', expirationDate: '', expired: false, verified: true, kiosk: true, firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', isMinor: true, autoTag: '', tags: ['Green Team'], flags: [{ displayText: 'Have you received our orientation?', reason: 'was not selected' }], events: [{ eventUuid: 5RT5Zfn4yjLFrcvgSyZQnX, name: 'Event Name', startDate: '2025-01-26 00:00:00', endDate: '2025-01-30 00:00:00' }] }], description: 'Signed waiver information', items: { type: object } }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (waivers)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (waivers)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
            tags:
                - Waivers
    '/v4/waivers/{waiverId}':
        get:
            summary: "Retrieve a signed waiver\nRetrieve a signed waiver"
            description: ''
            parameters:
                -
                    in: query
                    name: pdf
                    description: 'Include Base 64 encoded PDF of signed waiver Default value: false Allowed values: true, false.'
                    example: 'false'
                    required: false
                    schema:
                        type: string
                        description: 'Include Base 64 encoded PDF of signed waiver Default value: false Allowed values: true, false.'
                        example: 'false'
                -
                    in: query
                    name: eventData
                    description: 'Include event data in the response Default value: false Allowed values: true, false.'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Include event data in the response Default value: false Allowed values: true, false.'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2017-01-24T11:14:25+00:00'
                                    type: waiver
                                    waiver: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', expirationDate: '', expired: false, verified: true, kiosk: true, firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', autoTag: '', clientIP: 192.0.2.0, email: example@smartwaiver.com, marketingAllowed: false, addressLineOne: '626 NW Arizona Ave.', addressLineTwo: 'Suite 2', addressCity: Bend, addressState: OR, addressZip: '97703', addressCountry: US, emergencyContactName: 'Mary Smith', emergencyContactPhone: 111-111-1111, insuranceCarrier: 'My Insurance', insurancePolicyNumber: '1234567', driversLicenseNumber: '9876543', driversLicenseState: OR, tags: ['Green Team'], flags: [{ displayText: 'Have you received our orientation?', reason: 'was not selected' }], participants: [{ firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', isMinor: true, gender: Male, phone: '', tags: ['YES'], customParticipantFields: { bk3xydss4e9dy: { value: 'YES', displayText: 'Is this participant ready to have fun?' } }, flags: [{ displayText: 'Are you excited?', reason: 'was not selected' }] }], events: [{ eventUuid: 5RT5Zfn4yjLFrcvgSyZQnX, name: textbox, startDate: '2025-01-26 00:00:00', endDate: '2025-01-30 00:00:00' }], pdf: 'Base64 Encoded PDF', photos: 1, guardian: { firstName: Kyle, middleName: '', lastName: 'Smith I', phone: 555-555-5555, relationship: Father, dob: '1970-12-25' }, customWaiverFields: { ha5bs1jy5wdop: { value: 'A friend', displayText: 'How did you hear about Smartwaiver?' } }, typedSignatures: { participants: [], guardian: [], bodySignatures: [], bodyInitials: [] } }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2017-01-24T11:14:25+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: waiver, description: 'Type of response given (waivers)' }
                                    waiver: { type: object, example: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', expirationDate: '', expired: false, verified: true, kiosk: true, firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', autoTag: '', clientIP: 192.0.2.0, email: example@smartwaiver.com, marketingAllowed: false, addressLineOne: '626 NW Arizona Ave.', addressLineTwo: 'Suite 2', addressCity: Bend, addressState: OR, addressZip: '97703', addressCountry: US, emergencyContactName: 'Mary Smith', emergencyContactPhone: 111-111-1111, insuranceCarrier: 'My Insurance', insurancePolicyNumber: '1234567', driversLicenseNumber: '9876543', driversLicenseState: OR, tags: ['Green Team'], flags: [{ displayText: 'Have you received our orientation?', reason: 'was not selected' }], participants: [{ firstName: Kyle, middleName: '', lastName: 'Smith II', dob: '2008-12-25', isMinor: true, gender: Male, phone: '', tags: ['YES'], customParticipantFields: { bk3xydss4e9dy: { value: 'YES', displayText: 'Is this participant ready to have fun?' } }, flags: [{ displayText: 'Are you excited?', reason: 'was not selected' }] }], events: [{ eventUuid: 5RT5Zfn4yjLFrcvgSyZQnX, name: textbox, startDate: '2025-01-26 00:00:00', endDate: '2025-01-30 00:00:00' }], pdf: 'Base64 Encoded PDF', photos: 1, guardian: { firstName: Kyle, middleName: '', lastName: 'Smith I', phone: 555-555-5555, relationship: Father, dob: '1970-12-25' }, customWaiverFields: { ha5bs1jy5wdop: { value: 'A friend', displayText: 'How did you hear about Smartwaiver?' } }, typedSignatures: { participants: [], guardian: [], bodySignatures: [], bodyInitials: [] } } }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (waivers)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (waivers)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (waivers)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Waivers
        parameters:
            -
                in: path
                name: waiverId
                description: 'Unique ID of signed waiver.'
                example: WAIVER_ID
                required: true
                schema:
                    type: string
    '/v4/waivers/{waiverId}/tempurl':
        get:
            summary: "Retrieve a signed waiver\nRetrieve a signed waiver"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        text/plain:
                            schema:
                                type: string
                                example: "{\n    \"version\": 4,\n    \"id\": \"a0256461ca244278b412ab3238f5efd2\",\n    \"ts\": \"2017-01-24T11:14:25+00:00\",\n    \"type\": \"waiver\",\n    \"waiver\":\n    {\n        \"temp_url\": \"https://exampleurl.com\",\n        \"waiverId\": \"6jebdfxzvrdkd\",\n        \"templateId\": \"sprswrvh2keeh\",\n        \"title\": \"Smartwaiver Demo Waiver\",\n        \"createdOn\": \"2017-01-24 13:12:29\",\n    }\n}\n"
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00' }
                                    type: { type: string, example: parameter_error }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00' }
                                    type: { type: string, example: data_error }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4 }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2 }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00' }
                                    type: { type: string, example: error }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Waivers
        parameters:
            -
                in: path
                name: waiverId
                description: 'Unique ID of signed waiver.'
                example: WAIVER_ID
                required: true
                schema:
                    type: string
    '/v4/waivers/{waiverId}/files':
        get:
            summary: "Retrieve files uploaded with a waiver\nRetrieve files uploaded with a waiver"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: files
                                    files: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', files: [{ type: kiosk, date: '2017-01-01 00:00:00', tag: 'IP: 192.168.2.0', fileType: jpg, fileId: CwLeDjffgDoGHua, file: 'BASE64 ENCODED FILE' }] }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: files, description: 'Type of response given (files)' }
                                    files: { type: object, example: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', files: [{ type: kiosk, date: '2017-01-01 00:00:00', tag: 'IP: 192.168.2.0', fileType: jpg, fileId: CwLeDjffgDoGHua, file: 'BASE64 ENCODED FILE' }] }, description: 'A list of files for the waiver' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (files)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Waivers
        parameters:
            -
                in: path
                name: waiverId
                description: 'Unique ID of signed waiver.'
                example: WAIVER_ID
                required: true
                schema:
                    type: string
    '/v4/waivers/{waiverId}/photos':
        get:
            summary: "Retrieve photos for a waiver\nRetrieve photos for a waiver"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: photos
                                    photos: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', photos: [{ type: kiosk, date: '2017-01-01 00:00:00', tag: 'IP: 192.168.2.0', fileType: jpg, photoId: CwLeDjffgDoGHua, photo: 'BASE64 ENCODED FILE' }] }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: photos, description: 'Type of response given (photos)' }
                                    photos: { type: object, example: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', photos: [{ type: kiosk, date: '2017-01-01 00:00:00', tag: 'IP: 192.168.2.0', fileType: jpg, photoId: CwLeDjffgDoGHua, photo: 'BASE64 ENCODED FILE' }] }, description: 'A list of photos for the waiver' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (photos)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Waivers
        parameters:
            -
                in: path
                name: waiverId
                description: 'Unique ID of signed waiver.'
                example: WAIVER_ID
                required: true
                schema:
                    type: string
    '/v4/waivers/{waiverId}/signatures':
        get:
            summary: "Retrieve signatures for a waiver\nRetrieve signatures for a waiver"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: signatures
                                    signatures: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', signatures: { participants: ['BASE64 ENCODED IMAGE STRING'], guardian: ['BASE64 ENCODED IMAGE STRING'], bodySignatures: ['BASE64 ENCODED IMAGE STRING'], bodyInitials: ['BASE64 ENCODED IMAGE STRING'] } }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: signatures, description: 'Type of response given (signatures)' }
                                    signatures: { type: object, example: { waiverId: 6jebdfxzvrdkd, templateId: sprswrvh2keeh, title: 'Smartwaiver Demo Waiver', createdOn: '2017-01-24 13:12:29', signatures: { participants: ['BASE64 ENCODED IMAGE STRING'], guardian: ['BASE64 ENCODED IMAGE STRING'], bodySignatures: ['BASE64 ENCODED IMAGE STRING'], bodyInitials: ['BASE64 ENCODED IMAGE STRING'] } }, description: 'Property containing all types of signatures. All values are arrays of base 64 encoded image strings.' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (signatures)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Waivers
        parameters:
            -
                in: path
                name: waiverId
                description: 'Unique ID of signed waiver.'
                example: WAIVER_ID
                required: true
                schema:
                    type: string
    /v4/webhooks/queues:
        get:
            summary: "Retrieve queue information\nRetrieve queue information"
            description: ''
            parameters:
                -
                    in: query
                    name: delete
                    description: 'Delete the message when it is retrieved Default value: false Allowed values: true, false'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Delete the message when it is retrieved Default value: false Allowed values: true, false'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: api_webhook_all_queue_message_count
                                    api_webhook_all_queue_message_count: { account: { messagesTotal: 2, messagesNotVisible: 0, messagesDelayed: 0 }, template-4fc7d12601941: { messagesTotal: 4, messagesNotVisible: 2, messagesDelayed: 0 } }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: api_webhook_all_queue_message_count, description: 'Type of response given (api_webhook_all_queue_message_count)' }
                                    api_webhook_all_queue_message_count: { type: object, example: { account: { messagesTotal: 2, messagesNotVisible: 0, messagesDelayed: 0 }, template-4fc7d12601941: { messagesTotal: 4, messagesNotVisible: 2, messagesDelayed: 0 } }, description: 'Webhook queue count information (Default value (no messages): null)' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (api_webhook_all_queue_message_count)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (api_webhook_all_queue_message_count)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
                502:
                    description: '502, Bad Gateway'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Failed to delete'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (api_webhook_all_queue_message_count)' }
                                    message: { type: string, example: 'Failed to delete' }
            tags:
                - 'Webhook Queues'
        parameters:
            -
                in: path
                name: templateId
                description: 'Unique ID of waiver template queue to delete the message from'
                example: TEMPLATE_ID
                required: true
                schema:
                    type: string
    /v4/webhooks/queues/account:
        get:
            summary: "Retrieve account message\nRetrieve account message"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: api_webhook_account_message_get
                                    api_webhook_account_message_get: { messageId: 9d58e8fc-6353-4ceb-b0a3-5412f3d05e28, payload: { unique_id: '', event: new-waiver } }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: api_webhook_account_message_get, description: 'Type of response given (api_webhook_account_message_get)' }
                                    api_webhook_account_message_get: { type: object, example: { messageId: 9d58e8fc-6353-4ceb-b0a3-5412f3d05e28, payload: { unique_id: '', event: new-waiver } }, description: 'Webhook queue count information (Default value (no messages): null)' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (api_webhook_account_message_get)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                502:
                    description: '502, Bad Gateway'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Failed to delete'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (api_webhook_account_message_get)' }
                                    message: { type: string, example: 'Failed to delete' }
            tags:
                - 'Webhook Queues'
    '/v4/webhooks/queues/template/{templateId}':
        get:
            summary: "Retrieve template message\nRetrieve template message"
            description: ''
            parameters:
                -
                    in: query
                    name: delete
                    description: 'Delete the message when it is retrieved Default value: false Allowed values: true, false'
                    example: null
                    required: false
                    schema:
                        type: string
                        description: 'Delete the message when it is retrieved Default value: false Allowed values: true, false'
                        example: null
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: api_webhook_template_message_get
                                    api_webhook_template_message_get: { messageId: 9d58e8fc-6353-4ceb-b0a3-5412f3d05e28, payload: { unique_id: '', event: new-waiver } }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: api_webhook_template_message_get, description: 'Type of response given (api_webhook_template_message_get)' }
                                    api_webhook_template_message_get: { type: object, example: { messageId: 9d58e8fc-6353-4ceb-b0a3-5412f3d05e28, payload: { unique_id: '', event: new-waiver } }, description: 'Webhook queue count information (Default value (no messages): null)' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (api_webhook_template_message_get)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                502:
                    description: '502, Bad Gateway'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Failed to delete'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (api_webhook_template_message_get)' }
                                    message: { type: string, example: 'Failed to delete' }
            tags:
                - 'Webhook Queues'
        parameters:
            -
                in: path
                name: templateId
                description: 'Unique ID of waiver template queue to delete the message from'
                example: TEMPLATE_ID
                required: true
                schema:
                    type: string
    '/v4/webhooks/queues/account/{messageId}':
        delete:
            summary: "Delete account message\nDelete a message from the account queue using the message ID returned when the message was retrieved. This is an option for the workflow to retrieve a message, process it, then delete it."
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: api_webhook_account_message_delete
                                    api_webhook_account_message_delete: { success: true }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: api_webhook_account_message_delete, description: 'Type of response given (api_webhook_account_message_delete)' }
                                    api_webhook_account_message_delete: { type: object, example: { success: true }, description: '' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (api_webhook_account_message_delete)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                502:
                    description: '502, Bad Gateway'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Failed to delete'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (api_webhook_account_message_delete)' }
                                    message: { type: string, example: 'Failed to delete' }
            tags:
                - 'Webhook Queues'
        parameters:
            -
                in: path
                name: messageId
                description: 'Unique ID of message returned when it was retrieved'
                example: MESSAGE_ID
                required: true
                schema:
                    type: string
    '/v4/webhooks/queues/template/{templateId}/{messageId}':
        delete:
            summary: "Delete template message\nDelete a message from the template queue using the message ID returned when the message was retrieved. This is an option for the workflow to retrieve a message, process it, then delete it."
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: api_webhook_template_message_delete
                                    api_webhook_template_message_delete: { success: true }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: api_webhook_template_message_delete, description: 'Type of response given (api_webhook_template_message_delete)' }
                                    api_webhook_template_message_delete: { type: object, example: { success: true }, description: '' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (api_webhook_template_message_delete)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                502:
                    description: '502, Bad Gateway'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Failed to delete'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (api_webhook_template_message_delete)' }
                                    message: { type: string, example: 'Failed to delete' }
            tags:
                - 'Webhook Queues'
        parameters:
            -
                in: path
                name: templateId
                description: 'Unique ID of waiver template queue to delete the message from.'
                example: TEMPLATE_ID
                required: true
                schema:
                    type: string
            -
                in: path
                name: messageId
                description: 'Unique ID of message returned when it was retrieved.'
                example: MESSAGE_ID
                required: true
                schema:
                    type: string
    '/v4/webhooks/resend/{waiverId}':
        put:
            summary: "Resend webhook\nResend the new-waiver webhook for the given waiver ID. This is for testing purposes only and is heavily rate limited. Note: This request is not included in the normal 100 request per minute limit, but is instead limited to 2 requests per minute by itself."
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: webhooks_resend
                                    webhooks_resend: { success: true }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: webhooks_resend, description: 'Type of response given (webhooks_resend)' }
                                    webhooks_resend: { type: object, example: { success: true }, description: 'Webhook information (empty because no webhook is set)' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (webhooks_resend)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (webhooks_resend)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (webhooks_resend)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
            tags:
                - Webhooks
        parameters:
            -
                in: path
                name: waiverId
                description: 'The Unique Id of the waiver'
                example: 0
                required: true
                schema:
                    type: integer
    /v4/webhooks/configure:
        get:
            summary: "Retrieve current webhook\nRetrieve current webhook"
            description: ''
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: webhooks
                                    webhooks: { endpoint: 'https://example.com/test1', emailValidationRequired: 'yes', endpoint2: 'https://example.com/test2', endpoint3: '' }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: webhooks, description: 'Type of response given (webhooks)' }
                                    webhooks: { type: object, example: { endpoint: 'https://example.com/test1', emailValidationRequired: 'yes', endpoint2: 'https://example.com/test2', endpoint3: '' }, description: 'Webhook information (empty because no webhook is set)' }
            tags:
                - Webhooks
        put:
            summary: 'Set webhook'
            description: "This endpoint configures webhooks. By default this manages the default webhook. If you have no webhooks setup it will create the default webhook.\n\nFor more information on webhooks: https://support.smartwaiver.com/hc/en-us/articles/360057049551-What-are-Webhooks\n\nIf you have a default webhook setup it will overrite that webhook unless you pass the `create:true` flag.\n\nIf you include the `create:true` flag the system will ignore the `webhookNumber` and create a new webhook in the next available place\n\nYou can only create up to 3 webhooks. You will get an error if you try to create more."
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                201:
                    description: '201'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: webhooks
                                    webhooks: [{ endpoint: 'https://smartwaiver.com', emailValidationRequired: both }]
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: webhooks, description: 'Type of response given (webhooks)' }
                                    webhooks: { type: array, example: [{ endpoint: 'https://smartwaiver.com', emailValidationRequired: both }], description: 'Webhook information (empty because no webhook is set)', items: { type: object } }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (webhooks)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
                402:
                    description: '402, Data Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: data_error
                                    message: 'Message explaining the invalid data entered'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: data_error, description: 'Type of response given (webhooks)' }
                                    message: { type: string, example: 'Message explaining the invalid data entered' }
                404:
                    description: '404, Not Found'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Route or Resource Id not found'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (webhooks)' }
                                    message: { type: string, example: 'Route or Resource Id not found' }
                406:
                    description: '406, Wrong Content Type'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: error
                                    message: 'Content-Type must be json'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: error, description: 'Type of response given (webhooks)' }
                                    message: { type: string, example: 'Content-Type must be json' }
            tags:
                - Webhooks
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                create:
                                    type: boolean
                                    description: 'Creates a new webhook instead of overwriting the default. Default (false)'
                                    example: false
                                webhookNumber:
                                    type: integer
                                    description: 'The webhook number to update (1,2,3) Default (1)'
                                    example: 1
                                searchWebhook:
                                    type: string
                                    description: 'The url of the webhook to update'
                                    example: 'https://example.com'
                                checkinWebhook:
                                    type: boolean
                                    description: 'Should the webhook send when users checkin. (This applies to all webhooks)'
                                    example: false
                                endpoint:
                                    type: required
                                    description: 'The webhook endpoint to set Allowable Values: Valid URL'
                                    example: 'https:\\smartwaiver.com\test'
                                emailValidationRequired:
                                    type: string
                                    description: 'Webhook is sent after email verification (yes), before (no), or before and after (both) Allowed values: yes, no, both (This applies to all webhooks)'
                                    example: 'yes'
                            required:
                                - emailValidationRequired
        delete:
            summary: 'Delete Webhook'
            description: "When you delete webhooks the system will automatically shift the rest of the webhooks so you still have a default. For example:\n\nIf you have three webhooks\n- endpoint 1:  https://example.com/test1\n- endpoint 2:  https://example.com/test2\n- endpoint 3:  https://example.com/test3\n\nAnd you delete endpoint 1 the system will shift the webhooks so that\n\n- endpoint 1:  https://example.com/test2\n- endpoint 2:  https://example.com/test3\n\nIf you would like to delete a specific webhook please use `searchWebhook` to specify the URL of webhook you would like to delete"
            parameters:
                -
                    in: header
                    name: Authorization
                    description: ''
                    example: 'Bearer [INSERT API KEY]'
                    schema:
                        type: string
                -
                    in: header
                    name: Content-Type
                    description: ''
                    example: application/json
                    schema:
                        type: string
                -
                    in: header
                    name: Accept
                    description: ''
                    example: application/json
                    schema:
                        type: string
            responses:
                200:
                    description: '200'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-20T20:09:53+00:00'
                                    type: webhooks
                                    webhooks: {  }
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-20T20:09:53+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: webhooks, description: 'Type of response given (webhooks)' }
                                    webhooks: { type: object, example: {  }, description: 'Webhook information (empty because no webhook is set)' }
                400:
                    description: '400, Parameter Error'
                    content:
                        application/json:
                            schema:
                                type: object
                                example:
                                    version: 4
                                    id: a0256461ca244278b412ab3238f5efd2
                                    ts: '2024-05-17T12:00:33+00:00'
                                    type: parameter_error
                                    message: 'Parameter <x> is not supported'
                                properties:
                                    version: { type: integer, example: 4, description: 'API version number' }
                                    id: { type: string, example: a0256461ca244278b412ab3238f5efd2, description: 'Uuid for request (32 characters)' }
                                    ts: { type: string, example: '2024-05-17T12:00:33+00:00', description: 'Timestamp of request' }
                                    type: { type: string, example: parameter_error, description: 'Type of response given (webhooks)' }
                                    message: { type: string, example: 'Parameter <x> is not supported' }
            tags:
                - Webhooks
        parameters:
            -
                in: path
                name: webhookNumber
                description: 'Optional parameter. The webhook number (1,2,3) Default (1)'
                required: true
                schema:
                    type: integer
                examples:
                    omitted:
                        summary: 'When the value is omitted'
                        value: ''
                    present:
                        summary: 'When the value is present'
                        value: 1
            -
                in: path
                name: searchWebhook
                description: 'Optional parameter. The url of the webhook to search'
                required: true
                schema:
                    type: string
                examples:
                    omitted:
                        summary: 'When the value is omitted'
                        value: ''
                    present:
                        summary: 'When the value is present'
                        value: 'https://example.com'
components:
    securitySchemes:
        default:
            type: http
            scheme: bearer
            description: ''
security:
    -
        default: []