|rest_limit||Change the maximum number of participants returned. E.g. if set to 10 it'll return 10 participants (instead of the default). This value must be smaller than 20.|
|rest_offset||Skip the first [value] results and then return the next [rest_limit] participants.|
|rest_request_hours||Only return participants created in the past [value] hours.|
|rest_accepted_hours||Only return participants accepted in the past [value] hours.|
|rest_request_utc||Only return participants created after [value] UTC date. Date must be in one of the following formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS|
|rest_request_accepted_utc||Only return participants accepted after [value] UTC date. Date must be in one of the following formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS|
|rest_waiverid||Only return participants with the specified waiver_id. This may be more than one participant if the waiver contains multiple participants.|
|rest_participant_id||Only return the participant with the specified participant_id.|
|rest_since_waiverid||Only return participants created after the specified waiver_id. Typically you'll want to use this in conjunction with rest_asc (below).|
|rest_asc||By default the newest waiver is shown first. If you add rest_asc the oldest will be shown first.|
|rest_request_lastname||Only return participants with [value] as the last name.|
|rest_request_dob||Only return participants with [value] as the date of birth. The [value] must be in the format: YYYYMMDD. Tip: If month or day are less than 10 you must add a 0 in front. i.e. 198211 should be 19820101|
|rest_request_tag||Only return participants with [value] as the tag.|
|rest_excludependingwaivers||By default participants that are pending email validation are returned via the API. Including this will exclude participants pending email validation.|
|waiver_id||A unique ID that identifies the participant's waiver. This will always be unique to this document.|
|participant_id||A unique ID that identifies the individual participant.|
|firstname||Participant's first name|
|middlename||Participant's middle name|
|lastname||Participant's last name|
|dob||Date of birth in ISO8601 format|
|date_created_utc||UTC time stamp when the waiver was created|
|date_accepted_utc||UTC time stamp when the waiver was accepted|
|pdf_url||To view the waiver point a browser to (note that you need to replace both APIKEY and VALUE_OF_PDF_URL): https://smartwaiver.com/api/v3/?rest_request=APIKEY&restapi_viewpdf=VALUE_OF_PDF_URL|
|pending_email_validation||Is the document pending email validation? (If true, the participant completed their waiver online and has not clicked on the confirmation link in their email).|
|waiver_title||Title of the document they completed|
|web_browsers_user_agent||Participant's user agent|
|completed_from_ip_address||IP address that the participant completed the waiver at|
|marketingallowed||Did the customer opt-in to your maillist? This will be true,false or "not asked". "not asked" means that the waiver asked for their email but did not ask permission to send them marketing email. False means that the customer opted out. True means that the customer opted in.|
|waiver_type_guid||The unique identifier of the waiver type. This can be compared to Waiver Type API calls.|
|completed_at_kiosk||If this is true the waiver was completed at a kiosk (at your facility). If this is false the waiver was completed online (e.g. at the participant's home before visiting).|
|how_many_auto_photo_capture_photographs_captured||How many photographs were taken using auto photo capture.|
|value||Value of the custom field|
|title||Title of the custom field|
|value_iso8601||ISO8601 is only included for date fields. Example: If value is set to "January 2, 2013" value_iso8601 would be "2013-01-02".|
Auto Photo Capture - automatically takes photos of the participant signing the waiver. These photos will be added to the signed PDF copy of the waiver.
Photo Attach - allows staff members to take photos of a participant or ID after the waiver has been signed and submitted. These photos are not added to the signed PDF copy of the waiver.
Important: Images are associated at the waiver level (as opposed to the participant level). So if the waiver includes multiple participants (i.e., Minors and Adults) the photos will most likely be of of the signing adult and not the minor.
You can identify the type of photo by comparing the <source>.
Auto Photo Capture photos will be assigned a <source> of autophotocapture.
Photo Attach photos will be assigned a <source> of photoattach.
<date_utc> is a UTC timestamp for when the photo was captured.
<img_url> is a private value that allows you to download the images to your local server.
The above API call will return the image in the format specified in <file_ext> (typically jpg).
Security Tip: Never stream images on your site using the API! This will open your API key to the public. Instead, save a local copy.
<tag> gives information regarding why the photo was captured or the IP that attached it.
<checkins> can contain any number of <checkin> each which specify:
<checkin_id> A unique identifier for this check-in.
<checkin_utc> UTC time stamp when the check-in occurred.