{"info":{"title":"Scrive Flow API","description":"This is a specification of an API for configuring and managing Scrive Flow processes.\n\nHere are some of the additional documentation resources that should be available if you're viewing this document through a Scrive service.\n* [API documentation](/experimental/flow/documentation/), complete documentation for the Scrive Flow product.\n* [API changelog](/experimental/flow/documentation/api-reference/changelog), a list of past changes to the specification.\n* [Migration guide](/experimental/flow/documentation/api-reference/migrations), a guide explaining how to migrate to new versions.\n* [Code assistance for API calls](/experimental/flow/documentation/how-to/code-assistance), a how-to for improving writing Flow API request with the help of JSON Schemas.","version":"0.50.0"},"servers":[{"url":"https://scrive.com"}],"paths":{"/experimental/flow/drafts":{"get":{"tags":["Drafts"],"summary":"List Flow drafts","description":"Lists all Flow drafts authored by the authenticated user.","responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/drafts_list_item"}}}}}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"post":{"tags":["Drafts"],"summary":"Create a Flow draft","description":"Creates a new Flow draft. Drafts are instances that can be freely modified until started.\n\nYou can provide partial information for the draft when creating it and add the rest later before finally starting it.\n\nThe `process` DSL or `process_parameters` are not validated when creating the draft.","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/create_draft"}}}},"responses":{"201":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/get_draft"}}}},"400":{"description":"Invalid `body`"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/drafts/{draft_id}":{"get":{"tags":["Drafts"],"summary":"Get a Flow draft","description":"Gets all details about a draft.","parameters":[{"name":"draft_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested draft.","type":"string","format":"uuid"}}],"responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/get_draft"}}}},"404":{"description":"`draft_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"delete":{"tags":["Drafts"],"summary":"Delete a Flow draft","description":"Deletes a Flow draft","parameters":[{"name":"draft_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested draft.","type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"404":{"description":"`draft_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"patch":{"tags":["Drafts"],"summary":"Update a Flow draft","description":"Updates the Flow draft.\n\nSetting any optionally nullable field to `null` will remove if from the draft. Setting the `folder_id` field will move the draft to that folder.\n\nThe `process` DSL or `process_parameters` are not validated when updating the draft.","parameters":[{"name":"draft_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested draft.","type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/patch_draft"}}}},"responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/get_draft"}}}},"400":{"description":"Invalid `body`"},"404":{"description":"`draft_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/drafts/{draft_id}/start":{"post":{"tags":["Drafts"],"summary":"Start a Flow instance from a draft","description":"Turns a Flow draft into a Flow instance and starts it.\n\nAll the request fields are optional. They override the data in the draft. Setting any optionally nullable field to `null` will remove it from the draft.\n\nBefore turning the draft into an instance, its state is validated and the objects referenced in the `process` DSL and `process_parameters` are checked to be in a good state (for example, all documents are ready to be started).\n\nOnce the validation is finished, the documents are started and the initial action of the `process` DSL is executed.","parameters":[{"name":"draft_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested draft.","type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/start_draft"}}}},"responses":{"201":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/get_instance"}}}},"400":{"description":"Invalid `body`"},"404":{"description":"`draft_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/{instance_id}":{"get":{"tags":["Instances"],"summary":"Get a Flow instance","description":"Gets all details about an instance.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/get_instance"}}}},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"delete":{"tags":["Instances"],"summary":"Delete a Flow instance","description":"Deletes a trashed Flow instance, making it inaccessible to the author and administrator of the instance. Participants still have access to deleted instances for 30 days after the process has finished. Only trashed instances can be deleted.\n\n**Note**: Deleting an instance is irreversible.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/start":{"post":{"tags":["Instances"],"summary":"Start a new Flow instance","description":"Creates and starts a new Flow instance.\n\nBefore starting the instance, its state is validated and the objects referenced in the `process` DSL and `process_parameters` are checked to be in a good state (for example, all documents are ready to be started).\n\nOnce the validation is finished, the documents are started and the initial action of the `process` DSL is executed.","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/start_instance"}}}},"responses":{"201":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/get_instance"}}}},"400":{"description":"Invalid `body`"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/{instance_id}/cancel":{"post":{"tags":["Instances"],"summary":"Cancel Flow instance","description":"Cancels a Flow instance, causing all unsealed documents in the Flow to also be cancelled. Only in-progress Flow instances can be cancelled.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/{instance_id}/trash":{"post":{"tags":["Instances"],"summary":"Trash Flow instance","description":"Trashes a Flow instance. Participants lose access to a trashed instance 30 days after it has finished. Only instances that are not in-progress can be trashed.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/{instance_id}/restore":{"post":{"tags":["Instances"],"summary":"Restore Flow instance","description":"Restores a trashed Flow instance if it has not already been deleted. Restored Flow instances become accessible to participants again.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/{instance_id}/prolong":{"post":{"tags":["Instances"],"summary":"Prolong timeout date","description":"Prolongs the timeout date of a Flow instance. Prolonging an in-progress instance moves the scheduled time out date to the future by the provided number of days. Prolonging a timed out instance restores it as in-progress and makes accessible to participants again. Trashed instances cannot be prolonged, they must be restored first.\n\n**Note**: Time out date of an instance can be at most 365 days in the future.\n\n**Note**: Shortening the expected time out date by providing a negative value is not allowed.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/event_prolong_instance"}}}},"responses":{"204":{"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/instances/{instance_id}/notify_participants":{"post":{"tags":["Instances"],"summary":"Notify participants","description":"Sends SMS or e-mail notification with custom message to the participants. Notifications can be sent only for in progress instances.","parameters":[{"name":"instance_id","required":true,"in":"path","schema":{"description":"Unique identifier of the requested instance.","type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/event_notify_participant"},"minItems":1}}}},"responses":{"204":{"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`instance_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/folder/data_retention_policy":{"get":{"tags":["Data Retention"],"summary":"Get data retention policy","description":"Gets the data retention policy of the caller's home folder.","responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/flow_data_retention_policy"}}}}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"put":{"tags":["Data Retention"],"summary":"Set the data retention policy","description":"Sets the data retention policy of the caller's home folder. Subfolders inherit retention policies except if they have one already set.","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/flow_data_retention_policy"}}}},"responses":{"204":{"description":""},"400":{"description":"Invalid `body`"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"delete":{"tags":["Data Retention"],"summary":"Delete data retention policy","description":"Deletes the data retention policy of the caller's home folder.","responses":{"204":{"description":""}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/folder/{folder_id}/data_retention_policy":{"get":{"tags":["Data Retention"],"summary":"Get data retention policy of a given folder","description":"Gets the data retention policy of the specified folder.","parameters":[{"name":"folder_id","required":true,"in":"path","schema":{"example":"123","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/flow_data_retention_policy"}}}},"404":{"description":"`folder_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"put":{"tags":["Data Retention"],"summary":"Set the data retention policy","description":"Sets the data retention policy of the specified folder. Subfolders inherit retention policies except if they have one already set.","parameters":[{"name":"folder_id","required":true,"in":"path","schema":{"example":"123","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/flow_data_retention_policy"}}}},"responses":{"204":{"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`folder_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]},"delete":{"tags":["Data Retention"],"summary":"Delete data retention policy of a given folder","description":"Deletes the data retention policy of the specified folder.","parameters":[{"name":"folder_id","required":true,"in":"path","schema":{"example":"123","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`folder_id` not found"}},"security":[{"OAuth1.0":[]},{"OAuth2.0":["full"]},{"SessionCookie":[],"XToken":[]}]}},"/experimental/flow/version":{"get":{"tags":["No Auth"],"summary":"Get the Flow API version","description":"Gets the version information of Flow service.","responses":{"200":{"description":"","content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/version"}}}}}}}},"components":{"schemas":{"drafts_list_item":{"title":"drafts_list_item","required":["id","created","author_id","folder_id"],"properties":{"id":{"description":"Unique identifier of the draft.","example":"5694310c-08f3-4669-a8b3-351b7d58a36b","type":"string","format":"uuid"},"title":{"type":"string"},"process":{"$ref":"#/components/schemas/FlowDSL"},"callback":{"$ref":"#/components/schemas/callback"},"created":{"$ref":"#/components/schemas/UTCTime"},"author_id":{"$ref":"#/components/schemas/UserID"},"folder_id":{"$ref":"#/components/schemas/FolderID"}},"example":{"author_id":"321","callback":null,"created":"2021-01-27T00:00:00Z","folder_id":"456","id":"5694310c-08f3-4669-a8b3-351b7d58a36b","process":{"allow-rejections":true,"automatic-reminders":[],"dsl-version":"0.2.0","stages":[{"initial-stage":{"actions":[{"notify":{"kind":"standard","methods":{"email":"msg1","email-link-only":null,"sms":"msg2"},"users":["user1"]}}],"expect":{"signed-by":{"documents":["doc1","doc2"],"users":["user1"]}}}}]},"title":"foobar"},"type":"object"},"FlowDSL":{"description":"Description of the signing process in Flow DSL.\n\nMost of the strings encountered in this object are interpreted as abstract variables,\nto be set when a Flow instance is created. Thus one can reuse this template for multiple\nconcrete processes with their own sets of concrete users, documents, and messages.\n\nA Flow Process is composed of stages. Every _regular_ stage consists of actions\ntaken immediately and conditions that need to be satisfied to move to the next stage.\n\nThe last stage in the `stages` list may be defined as a _confirmation_ stage.\nA confirmation stage is a special case that consists of a notification action\nwith its `kind` field set to \"confirmation\" and an empty set of `expect` conditions.\nIf missing, the old per-document notifications will be sent out.\nThis behaviour will change, from sending per-document confirmation notifications\nby default, to sending unified flow confirmation notifications, in the future.\n","required":["stages","dsl-version"],"properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/FlowDSLStage"}},"dsl-version":{"$ref":"#/components/schemas/DslVersion"},"allow-rejections":{"$ref":"#/components/schemas/AllowRejections"},"automatic-reminders":{"type":"array","items":{"$ref":"#/components/schemas/AutomaticReminder"}}},"example":{"allow-rejections":true,"automatic-reminders":[],"dsl-version":"0.2.0","stages":[{"initial-stage":{"actions":[{"notify":{"kind":"standard","methods":{"email":"msg1","email-link-only":null,"sms":"msg2"},"users":["user1"]}}],"expect":{"signed-by":{"documents":["doc1","doc2"],"users":["user1"]}}}}]},"type":"object"},"FlowDSLStage":{"oneOf":[{"$ref":"#/components/schemas/FlowDSLStageRegular"},{"$ref":"#/components/schemas/FlowDSLStageConfirmation"}]},"FlowDSLStageRegular":{"description":"Stage of a Flow process. It consists of actions taken immediately\nand conditions that need to be satisfied to move to the next stage.","additionalProperties":{"required":["actions","expect"],"properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/SystemAction"}},"expect":{"$ref":"#/components/schemas/Expect"}},"type":"object"},"maxProperties":1,"minProperties":1,"type":"object"},"SystemAction":{"description":"Specifies an action that should be performed upon entering a stage.","oneOf":[{"$ref":"#/components/schemas/NotifyAction"},{"$ref":"#/components/schemas/AllowViewingAction"},{"$ref":"#/components/schemas/DenyViewingAction"},{"$ref":"#/components/schemas/CallbackAction"}]},"NotifyAction":{"description":"Notify participants with a message.","required":["notify"],"properties":{"notify":{"$ref":"#/components/schemas/NotifyDetails"}},"type":"object"},"NotifyDetails":{"description":"Notify participants with a message.","required":["users","methods"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}},"methods":{"$ref":"#/components/schemas/NotifyMethods"},"kind":{"$ref":"#/components/schemas/notify_kind"}},"type":"object"},"UserName":{"description":"The placeholder name for a participant in a process.","example":"user1","type":"string"},"NotifyMethods":{"description":"Specifies what communication methods to use.","properties":{"email":{"$ref":"#/components/schemas/MessageName"},"sms":{"$ref":"#/components/schemas/MessageName"},"email-link-only":{"type":"boolean"}},"type":"object"},"MessageName":{"description":"The placeholder name for a message to be sent by a process.","example":"msg1","type":"string"},"notify_kind":{"description":"Specifies the kind of notification action (standard or confirmation).","example":"standard","type":"string","enum":["standard","confirmation"]},"AllowViewingAction":{"description":"Assign documents viewing permissions to participants.","required":["allow-viewing"],"properties":{"allow-viewing":{"$ref":"#/components/schemas/AllowViewingDetails"}},"type":"object"},"AllowViewingDetails":{"description":"Assign documents viewing permissions to participants.","required":["users","documents"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}}},"type":"object"},"DocumentName":{"description":"The placeholder name for a document in a process.","example":"doc1","type":"string"},"DenyViewingAction":{"description":"Deny documents viewing permissions to participants.","required":["deny-viewing"],"properties":{"deny-viewing":{"$ref":"#/components/schemas/DenyViewingDetails"}},"type":"object"},"DenyViewingDetails":{"description":"Deny documents viewing permissions to participants.","required":["users","documents"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}}},"type":"object"},"CallbackAction":{"description":"Send a custom callback.","required":["callback"],"properties":{"callback":{"$ref":"#/components/schemas/CallbackDetails"}},"type":"object"},"CallbackDetails":{"description":"Send a custom callback.","required":["callback-name"],"properties":{"callback-name":{"$ref":"#/components/schemas/CallbackName"}},"type":"object"},"CallbackName":{"description":"The name of a custom callback. This name is sent to you in the callback payload.","example":"my-custom-callback-1","type":"string","maxLength":128},"Expect":{"description":" This object encapsulates the set of expectations that can be\nprovided when setting up a particular stage. These come in the form of conditions\nthat must be met.\"","properties":{"approved-by":{"$ref":"#/components/schemas/ApprovedBy"},"approved-by-group-of":{"$ref":"#/components/schemas/ApprovedByGroupOf"},"signed-by":{"$ref":"#/components/schemas/SignedBy"},"signed-by-group-of":{"$ref":"#/components/schemas/SignedByGroupOf"},"viewed-by":{"$ref":"#/components/schemas/ViewedBy"},"redirect-to":{"$ref":"#/components/schemas/RedirectTo"}},"type":"object"},"ApprovedBy":{"description":"This type specifies which users should have to approve a given\nset of documents in order to satisfy the approved-by expectation.","required":["documents","users"],"properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}}},"type":"object"},"ApprovedByGroupOf":{"description":"This type specifies a required quorum of users should have to\napprove a given set of documents in order to satisfy the approved-by-group-of\nexpectation.","required":["required-approvals","documents","users"],"properties":{"required-approvals":{"type":"integer","maximum":18446744073709551615,"minimum":0},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}}},"type":"object"},"SignedBy":{"description":"This type specifies which users should have to sign a given set\nof documents in order to satisfy the signed-by expectation.","required":["documents","users"],"properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}}},"type":"object"},"SignedByGroupOf":{"description":"This type specifies a required quorum of users should have\nto sign a given set of documents in order to satisfy the signed-by-group-of\nexpectation.","required":["required-signatures","documents","users"],"properties":{"required-signatures":{"type":"integer","maximum":18446744073709551615,"minimum":0},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}}},"type":"object"},"ViewedBy":{"description":"This type specifies which users should have to view a given set\nof documents in order to satisfy the viewed-by expectation.","required":["documents","users"],"properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentName"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}}},"type":"object"},"RedirectTo":{"description":"This type specifies a URL where the user can be redirected to.","required":["users","url"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}},"url":{"$ref":"#/components/schemas/Url"}},"type":"object"},"Url":{"description":"A URL string","example":"https://www.example.com","type":"string","format":"url"},"FlowDSLStageConfirmation":{"description":"A Confirmation stage is a special case that consists of a notification\naction with its `kind` field set to \"confirmation\" and empty set of\n`expect` conditions.  This stage must be at the end of `stages` list.\n\nIf missing, the old per-document notifications will be sent out. This behaviour\nwill change, from sending per-document confirmation notifications by default,\nto sending unified flow confirmation notifications, in the future.","additionalProperties":{"required":["actions","expect"],"properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/ConfirmationAction"},"maxItems":1,"minItems":1},"expect":{"description":"Empty object","maxProperties":0,"type":"object"}},"type":"object"},"maxProperties":1,"minProperties":1,"type":"object"},"ConfirmationAction":{"description":"Notify all the participants with a confirmation message.","required":["notify"],"properties":{"notify":{"allOf":[{"$ref":"#/components/schemas/ConfirmationDetails"},{"required":["kind"],"properties":{"kind":{"type":"string","enum":["confirmation"]}},"type":"object"}]}},"type":"object"},"ConfirmationDetails":{"description":"Notify all the participants with a confirmation message.","required":["users","methods"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserName"}},"methods":{"$ref":"#/components/schemas/NotifyMethods"}},"type":"object"},"DslVersion":{"description":"Process version","example":"0.2.0","type":"string"},"AllowRejections":{"description":"Allow participants to reject the instance","default":true,"type":"boolean"},"AutomaticReminder":{"description":"Automatic reminder configuration for a user","required":["user-name","date","method"],"properties":{"user-name":{"$ref":"#/components/schemas/UserName"},"date":{"$ref":"#/components/schemas/reminder_date"},"method":{"$ref":"#/components/schemas/AutomaticReminderMethod"}},"default":{"date":{"days_delay":7,"repeat":null,"time":{"time_of_day":"09:00:00","time_zone":"Europe/Stockholm"},"type":"relative"},"method":"email","user-name":"user"},"type":"object"},"reminder_date":{"title":"reminder_date","description":"Specifies when the reminder should be sent.","oneOf":[{"title":"absolute","required":["type","date_time"],"properties":{"type":{"description":"The reminder time is a specific UTC date and time.","type":"string","enum":["absolute"]},"date_time":{"description":"The UTC date and time for the reminder.","example":"2026-01-15T09:30:00Z","type":"string","format":"yyyy-mm-ddThh:MM:ssZ"}},"type":"object"},{"title":"relative","required":["type","days_delay"],"properties":{"type":{"description":"The reminder is sent after a specific number of days of inactivity.","type":"string","enum":["relative"]},"days_delay":{"description":"Number of days before a reminder is sent.","example":7,"type":"integer","maximum":365,"minimum":1},"time":{"$ref":"#/components/schemas/reminder_relative_time"},"repeat":{"$ref":"#/components/schemas/reminder_repeat"}},"example":{"days_delay":7,"repeat":null,"time":null},"type":"object"}],"example":{"days_delay":7,"repeat":null,"time":null,"type":"relative"},"type":"object"},"reminder_relative_time":{"title":"reminder_relative_time","description":"Time of day in a specific time zone.","required":["time_of_day","time_zone"],"properties":{"time_of_day":{"$ref":"#/components/schemas/TimeOfDay"},"time_zone":{"description":"The [IANA time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) TZ identifier.\n\nFor example: `Europe/Stockholm`, or `Etc/UTC`","example":"Europe/Stockholm","type":"string"}},"example":{"time_of_day":"09:00:00","time_zone":"Europe/Stockholm"},"type":"object"},"TimeOfDay":{"description":"Time of day when the reminder will be sent.","example":"09:00:00","type":"string","format":"hh:MM:ss"},"reminder_repeat":{"description":"Whether the reminder repeats. With `periodically`, a new reminder is scheduled every time one is sent, using the same `days_delay` and `time`, for as long as the participant still has pending actions and the instance is running. Omitting the field is equivalent to `never`, in which case a single reminder is sent.","example":"periodically","default":"never","type":"string","enum":["never","periodically"]},"AutomaticReminderMethod":{"description":"Notification method","type":"string","enum":["email","sms","email-and-sms"]},"callback":{"title":"callback","description":"Callback object containing callback URL and optional authentication data.","required":["url","version"],"properties":{"url":{"$ref":"#/components/schemas/CallbackUrl"},"auth":{"$ref":"#/components/schemas/AuthMethod"},"version":{"$ref":"#/components/schemas/callback_version"}},"example":{"auth":{"password":"password","type":"basic","user":"user"},"url":"https://www.example.com/","version":1},"type":"object"},"CallbackUrl":{"description":"An absolute https or http URL for callback purposes.","example":"https://www.example.com/","type":"string"},"AuthMethod":{"title":"AuthMethod","description":"Authentication method for the callback.","oneOf":[{"title":"basic","description":"Basic callback authentication","required":["type","user","password"],"properties":{"type":{"type":"string","enum":["basic"]},"user":{"type":"string"},"password":{"type":"string"}},"type":"object"},{"title":"none","required":["type"],"properties":{"type":{"type":"string","enum":["none"]}},"type":"object"}],"example":{"password":"password","type":"basic","user":"user"},"default":{"type":"none"},"type":"object"},"callback_version":{"description":"The Flow callback version that you would like to use.","example":1,"type":"string","enum":["v1"]},"UTCTime":{"example":"2016-07-22T00:00:00Z","type":"string","format":"yyyy-mm-ddThh:MM:ssZ"},"UserID":{"description":"Unique Scrive User ID.","example":"123","type":"string"},"FolderID":{"description":"Unique Scrive Folder ID.","example":"456","type":"string"},"get_draft":{"title":"get_draft","required":["id","created","author_id","folder_id"],"properties":{"id":{"description":"Unique identifier of the draft.","example":"5694310c-08f3-4669-a8b3-351b7d58a36b","type":"string","format":"uuid"},"title":{"type":"string"},"process":{"$ref":"#/components/schemas/FlowDSL"},"process_parameters":{"$ref":"#/components/schemas/process_parameters"},"callback":{"$ref":"#/components/schemas/get_callback"},"created":{"$ref":"#/components/schemas/UTCTime"},"author_id":{"$ref":"#/components/schemas/UserID"},"folder_id":{"$ref":"#/components/schemas/FolderID"},"duration":{"title":"duration","description":"How long before an in-progress instance times out. It cannot exceed 365 days in total.","properties":{"days":{"type":"integer","maximum":365,"minimum":0},"hours":{"type":"integer","maximum":8760,"minimum":0},"minutes":{"type":"integer","maximum":525600,"minimum":0}},"example":{"days":15,"hours":7,"minutes":42},"default":{"days":90,"hours":null,"minutes":null},"type":"object"}},"example":{"author_id":"321","callback":null,"created":"2021-01-27T00:00:00Z","duration":{"days":90,"hours":null,"minutes":null},"folder_id":"456","id":"5694310c-08f3-4669-a8b3-351b7d58a36b","process":{"allow-rejections":true,"automatic-reminders":[],"dsl-version":"0.2.0","stages":[{"initial-stage":{"actions":[{"notify":{"kind":"standard","methods":{"email":"msg1","email-link-only":null,"sms":"msg2"},"users":["user1"]}}],"expect":{"signed-by":{"documents":["doc1","doc2"],"users":["user1"]}}}}]},"process_parameters":null,"title":"foobar"},"type":"object"},"process_parameters":{"title":"process_parameters","description":"This object specifies concrete values for the abstract process parameters.","required":["documents","users","messages"],"properties":{"documents":{"additionalProperties":{"$ref":"#/components/schemas/DocumentID"},"type":"object"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserConfiguration"},"type":"object"},"messages":{"additionalProperties":{"$ref":"#/components/schemas/Message"},"type":"object"}},"example":{"documents":{"doc1":"123"},"messages":{"msg1":"foobar"},"users":{"user1":{"auth_to_view":{"attempts_per_sms":1,"max_failures":3,"provider":"sms_otp"},"auth_to_view_archived":null,"id":"foo@example.com","id_type":"email"}}},"type":"object"},"DocumentID":{"description":"Unique identifier for a document.","example":"123","type":"string"},"UserConfiguration":{"title":"user_configuration_json","description":"A user's `FlowUserId` together with process settings specific to that user.\n\nAt the moment only authentication settings are supported. Specifically one can enable authentication to view the overview page of a workflow and also authentication to view the workflow once it's completed (archived).\n\nThe authentication settings are optional.","required":["id","id_type"],"properties":{"id":{"type":"string"},"id_type":{"$ref":"#/components/schemas/user_id_type"},"auth_to_view":{"$ref":"#/components/schemas/authentication_configuration"},"auth_to_view_archived":{"$ref":"#/components/schemas/authentication_configuration"}},"example":{"auth_to_view":{"attempts_per_sms":1,"max_failures":3,"provider":"sms_otp"},"auth_to_view_archived":null,"id":"foo@example.com","id_type":"email"},"type":"object"},"user_id_type":{"description":"This type specifies which kind of Scrive Flow User ID is in use.","example":"phone_number","type":"string","enum":["email","phone_number","user_id","full_name"]},"authentication_configuration":{"title":"authentication_configuration","description":"This structure describes the requirements for authentication of a given user in the flow process.\n\nSee the `UserConfiguration` item in this spec for more details. Within `UserConfiguration` you may specify an `AuthenticationConfiguration` instance for its `auth_to_view` and `auth_to_view_archived` fields to specify what forms of authentication a user must provide in each situation.","oneOf":[{"title":"sms_otp","required":["provider","max_failures"],"properties":{"provider":{"type":"string","enum":["sms_otp"]},"max_failures":{"description":"The number of times a participant is allowed to fail to authenticate.\n\nAfter failing this many times the participant can make a final attempt, which has to succeed. If the final attempt is a failure the whole process fails.\n\nProviding a number outside the range of 0 to 255 will not cause an error but the number will be clamped.","example":3,"type":"integer","maximum":255,"minimum":0},"attempts_per_sms":{"description":"Limit to how many times the participant can input an incorrect OTP code they received in\nan authentication SMS. Once the limit is reached, the authentication attempt fails.","example":5,"default":5,"type":"integer","maximum":5,"minimum":1}},"type":"object"},{"title":"onfido","required":["provider","max_failures"],"properties":{"provider":{"type":"string","enum":["onfido"]},"max_failures":{"description":"The number of times a participant is allowed to fail to authenticate.\n\nAfter failing this many times the participant can make a final attempt, which has to succeed. If the final attempt is a failure the whole process fails.\n\nProviding a number outside the range of 0 to 255 will not cause an error but the number will be clamped.","example":3,"type":"integer","maximum":255,"minimum":0},"method":{"$ref":"#/components/schemas/OnfidoMethod"},"allowed_document_countries":{"description":"List of document-issuing countries","type":"array","items":{"$ref":"#/components/schemas/OnfidoCountry"},"minItems":1,"uniqueItems":true},"allowed_document_types":{"type":"array","items":{"$ref":"#/components/schemas/onfido_document_type"},"minItems":1,"uniqueItems":true},"document_capture":{"$ref":"#/components/schemas/onfido_document_capture"},"additional_report_info":{"$ref":"#/components/schemas/onfido_additional_report_info"},"email":{"type":"string"}},"type":"object"},{"title":"se_bankid","required":["provider","max_failures"],"properties":{"provider":{"type":"string","enum":["se_bankid"]},"max_failures":{"description":"The number of times a participant is allowed to fail to authenticate.\n\nAfter failing this many times the participant can make a final attempt, which has to succeed. If the final attempt is a failure the whole process fails.\n\nProviding a number outside the range of 0 to 255 will not cause an error but the number will be clamped.","example":3,"type":"integer","maximum":255,"minimum":0}},"type":"object"},{"title":"dk_mitid","required":["provider","max_failures"],"properties":{"provider":{"type":"string","enum":["dk_mitid"]},"max_failures":{"description":"The number of times a participant is allowed to fail to authenticate.\n\nAfter failing this many times the participant can make a final attempt, which has to succeed. If the final attempt is a failure the whole process fails.\n\nProviding a number outside the range of 0 to 255 will not cause an error but the number will be clamped.","example":3,"type":"integer","maximum":255,"minimum":0}},"type":"object"},{"title":"no_bankid","required":["provider","max_failures"],"properties":{"provider":{"type":"string","enum":["no_bankid"]},"max_failures":{"description":"The number of times a participant is allowed to fail to authenticate.\n\nAfter failing this many times the participant can make a final attempt, which has to succeed. If the final attempt is a failure the whole process fails.\n\nProviding a number outside the range of 0 to 255 will not cause an error but the number will be clamped.","example":3,"type":"integer","maximum":255,"minimum":0},"ui_locale":{"$ref":"#/components/schemas/NOUiLocale"}},"type":"object"},{"title":"ftn","required":["provider","max_failures"],"properties":{"provider":{"type":"string","enum":["ftn"]},"max_failures":{"description":"The number of times a participant is allowed to fail to authenticate.\n\nAfter failing this many times the participant can make a final attempt, which has to succeed. If the final attempt is a failure the whole process fails.\n\nProviding a number outside the range of 0 to 255 will not cause an error but the number will be clamped.","example":3,"type":"integer","maximum":255,"minimum":0},"ui_locale":{"$ref":"#/components/schemas/UiLocale"},"force_bank":{"$ref":"#/components/schemas/TupasBank"}},"type":"object"}],"type":"object"},"OnfidoMethod":{"description":"Optional parameter which specifies if Onfido requests only document or both document and a proof of facial similarity.","example":"document","default":"document","type":"string","enum":["document","document_and_photo","document_and_video","document_and_motion"]},"OnfidoCountry":{"description":"Document-issuing country in ISO 3166-1 alpha-3 code, e.g. SWE or GBR. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).","type":"string"},"onfido_document_type":{"description":"Types of documents that the user can choose from to authenticate.\n\nIf not specified all the document types are allowed.","example":"national_identity_card","type":"string","enum":["national_identity_card","driving_licence","passport","residence_permit"]},"onfido_document_capture":{"description":"Optional parameter to specify the devices that can be used to perform Onfido authentication.\n\nIf not specified Onfido authentication is allowed from mobile only devices..","example":"mobile_only","default":"mobile_only","type":"string","enum":["mobile_only","mobile_or_desktop"]},"onfido_additional_report_info":{"description":"Optional parameter to specify additional report information for Onfido authentication.\n\nIf not specified no additional report information will be requested.","example":"driving_licence_info","type":"string","enum":["driving_licence_info","address_info"]},"NOUiLocale":{"description":"If not provided, the end user's browser language preferences will be used to pick the most compatible language from the options available. If no supported languages are found, then Norwegian Bokmål (`nb`) is used as a default.","type":"string","enum":["nb","en"]},"UiLocale":{"description":"If not provided, the end user's browser language preferences will be used to pick the most compatible language from the options available. If no supported languages are found, then Norwegian Bokmål (`nb-NO`) is used as a default.","type":"string","enum":["nb-NO","en-GB","da-DK","sv-SE","fi-FI","sv-FI"]},"TupasBank":{"description":"A finnish Bank or MobileID (Mobiilivarmenne)","type":"string","enum":["nordea","opbank","danske","handelsbanken","aland","sbank","aktia","popbank","savingsbank","omasp","mobileid"]},"Message":{"description":"Custom message text for a notification.","example":"Foo bar!","type":"string"},"get_callback":{"title":"get_callback","description":"Callback object containing callback URL and the authentication type.","required":["url","auth_type","version"],"properties":{"url":{"$ref":"#/components/schemas/CallbackUrl"},"auth_type":{"$ref":"#/components/schemas/FlowCallbackAuthType"},"version":{"$ref":"#/components/schemas/callback_version"}},"example":{"auth_type":"none","url":"https://www.example.com/","version":1},"type":"object"},"FlowCallbackAuthType":{"type":"string","enum":["none","basic"]},"create_draft":{"title":"create_draft","properties":{"title":{"type":"string"},"process":{"$ref":"#/components/schemas/FlowDSL"},"process_parameters":{"$ref":"#/components/schemas/process_parameters"},"callback":{"$ref":"#/components/schemas/callback"},"folder_id":{"$ref":"#/components/schemas/FolderID"},"duration":{"title":"duration","description":"How long before an in-progress instance times out. It cannot exceed 365 days in total.","properties":{"days":{"type":"integer","maximum":365,"minimum":0},"hours":{"type":"integer","maximum":8760,"minimum":0},"minutes":{"type":"integer","maximum":525600,"minimum":0}},"example":{"days":15,"hours":7,"minutes":42},"default":{"days":90,"hours":null,"minutes":null},"type":"object"}},"example":{"callback":null,"duration":null,"folder_id":null,"process":{"allow-rejections":true,"automatic-reminders":[],"dsl-version":"0.2.0","stages":[{"initial-stage":{"actions":[{"notify":{"kind":"standard","methods":{"email":"msg1","email-link-only":null,"sms":"msg2"},"users":["user1"]}}],"expect":{"signed-by":{"documents":["doc1","doc2"],"users":["user1"]}}}}]},"process_parameters":null,"title":"foobar"},"type":"object"},"patch_draft":{"properties":{"title":{"$ref":"#/components/schemas/OptionalNullableField_Text"},"process":{"$ref":"#/components/schemas/OptionalNullableField_Process"},"process_parameters":{"$ref":"#/components/schemas/OptionalNullableField_ProcessParameters"},"callback":{"$ref":"#/components/schemas/OptionalNullableField_Callback"},"duration":{"$ref":"#/components/schemas/OptionalNullableField_InstanceDuration"},"folder_id":{"$ref":"#/components/schemas/FolderID"}},"type":"object"},"OptionalNullableField_Text":{"description":"_This is an optionally nullable field. Setting the field to `null` will remove any previously set value of this field._","oneOf":[{"type":"string"},{"title":"null","description":"","type":"null"}],"type":"string"},"OptionalNullableField_Process":{"description":"Description of the signing process in Flow DSL.\n\nMost of the strings encountered in this object are interpreted as abstract variables,\nto be set when a Flow instance is created. Thus one can reuse this template for multiple\nconcrete processes with their own sets of concrete users, documents, and messages.\n\nA Flow Process is composed of stages. Every _regular_ stage consists of actions\ntaken immediately and conditions that need to be satisfied to move to the next stage.\n\nThe last stage in the `stages` list may be defined as a _confirmation_ stage.\nA confirmation stage is a special case that consists of a notification action\nwith its `kind` field set to \"confirmation\" and an empty set of `expect` conditions.\nIf missing, the old per-document notifications will be sent out.\nThis behaviour will change, from sending per-document confirmation notifications\nby default, to sending unified flow confirmation notifications, in the future.\n\n\n_This is an optionally nullable field. Setting the field to `null` will remove any previously set value of this field._","oneOf":[{"$ref":"#/components/schemas/FlowDSL"},{"title":"null","description":"","type":"null"}],"type":"object"},"OptionalNullableField_ProcessParameters":{"description":"This object specifies concrete values for the abstract process parameters.\n\n_This is an optionally nullable field. Setting the field to `null` will remove any previously set value of this field._","oneOf":[{"$ref":"#/components/schemas/process_parameters"},{"title":"null","description":"","type":"null"}],"type":"object"},"OptionalNullableField_Callback":{"description":"Callback object containing callback URL and optional authentication data.\n\n_This is an optionally nullable field. Setting the field to `null` will remove any previously set value of this field._","oneOf":[{"$ref":"#/components/schemas/callback"},{"title":"null","description":"","type":"null"}],"type":"object"},"OptionalNullableField_InstanceDuration":{"description":"How long before an in-progress instance times out. It cannot exceed 365 days in total.\n\n_This is an optionally nullable field. Setting the field to `null` will remove any previously set value of this field._","oneOf":[{"title":"duration","description":"How long before an in-progress instance times out. It cannot exceed 365 days in total.","properties":{"days":{"type":"integer","maximum":365,"minimum":0},"hours":{"type":"integer","maximum":8760,"minimum":0},"minutes":{"type":"integer","maximum":525600,"minimum":0}},"example":{"days":15,"hours":7,"minutes":42},"default":{"days":90,"hours":null,"minutes":null},"type":"object"},{"title":"null","description":"","type":"null"}],"type":"object"},"get_instance":{"title":"get_instance","required":["id","process","process_parameters","state","access_links","admin_actions","participants","status","started","last_event","author_id","folder_id","documents","initiator"],"properties":{"id":{"description":"Unique identifier of the instance.","example":"30602e94-4205-4fa0-86b7-49205503c22b","type":"string","format":"uuid"},"title":{"type":"string"},"process":{"$ref":"#/components/schemas/FlowDSL"},"process_parameters":{"$ref":"#/components/schemas/process_parameters"},"state":{"$ref":"#/components/schemas/instance_state"},"access_links":{"additionalProperties":{"$ref":"#/components/schemas/Url"},"type":"object"},"admin_actions":{"type":"array","items":{"$ref":"#/components/schemas/admin_api_action"}},"participants":{"type":"array","items":{"$ref":"#/components/schemas/get_participant"}},"status":{"$ref":"#/components/schemas/status"},"started":{"$ref":"#/components/schemas/UTCTime"},"finished":{"$ref":"#/components/schemas/UTCTime"},"last_event":{"$ref":"#/components/schemas/UTCTime"},"trashed":{"$ref":"#/components/schemas/UTCTime"},"callback":{"$ref":"#/components/schemas/get_callback"},"author_id":{"$ref":"#/components/schemas/UserID"},"folder_id":{"$ref":"#/components/schemas/FolderID"},"timeout":{"description":"The date when the instance times out.","example":"2016-07-22T00:00:00Z","type":"string","format":"yyyy-mm-ddThh:MM:ssZ"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentID"},"uniqueItems":true},"initiator":{"$ref":"#/components/schemas/initiator"},"latest_reminder":{"description":"Timestamp of the most recent reminder sent in this instance, across all participants and covering both manual, bulk and automatic reminders.","example":"2026-01-15T09:30:00Z","type":"string","format":"yyyy-mm-ddThh:MM:ssZ"}},"example":{"access_links":{"user1":"https://some-env.scrive.com/experimental/flow/overview/eb4af357-28c9-410f-b432-66860955bc13/user1/ba5d504d14618def"},"admin_actions":[{"action":"notify_participant","participant_id":"78b4265b-e96e-4172-97b8-1144f6e71729"}],"author_id":"123","callback":{"auth_type":"none","url":"https://www.example.com/","version":1},"documents":["123"],"finished":null,"folder_id":"456","id":"30602e94-4205-4fa0-86b7-49205503c22b","initiator":"flow_api","last_event":"2021-05-04T00:00:00Z","latest_reminder":"2026-01-15T09:30:00Z","participants":[{"authentications":[{"label":"authId","max_attempts_reached":false,"parameters":{"attempts_per_sms":5,"mobile_number":null,"provider":"sms_otp"},"type":"standard"}],"automatic_reminder":{"date":"2026-01-15T09:30:00Z","settings":{"date":{"days_delay":7,"repeat":null,"time":null,"type":"relative"},"method":"email"}},"dsl_name":"user1","latest_reminder":"2021-05-04T00:00:00Z","participant_id":"78b4265b-e96e-4172-97b8-1144f6e71729","tags":[{"category":"full_name","value":"John Doe"},{"category":"email","value":"private.user@example.com"},{"category":"email","value":"corporate.user@example.com"}]}],"process":{"allow-rejections":true,"automatic-reminders":[],"dsl-version":"0.2.0","stages":[{"initial-stage":{"actions":[{"notify":{"kind":"standard","methods":{"email":"msg1","email-link-only":null,"sms":"msg2"},"users":["user1"]}}],"expect":{"signed-by":{"documents":["doc1","doc2"],"users":["user1"]}}}}]},"process_parameters":{"documents":{"doc1":"123"},"messages":{"msg1":"foobar"},"users":{"user1":{"auth_to_view":{"attempts_per_sms":1,"max_failures":3,"provider":"sms_otp"},"auth_to_view_archived":null,"id":"foo@example.com","id_type":"email"}}},"started":"2021-01-27T00:00:00Z","state":{"available_actions":[{"document":"123","type":"sign","user":{"id":"foo@example.com","id_type":"email"}}]},"status":"in_progress","timeout":null,"title":null,"trashed":null},"type":"object"},"instance_state":{"title":"instance_state","description":"This object displays the list of actions available to the participant.","required":["available_actions"],"properties":{"available_actions":{"type":"array","items":{"$ref":"#/components/schemas/instance_user_action_for_author"}}},"example":{"available_actions":[{"document":"123","type":"sign","user":{"id":"foo@example.com","id_type":"email"}}]},"type":"object"},"instance_user_action_for_author":{"title":"instance_user_action_for_author","required":["type","user"],"properties":{"type":{"$ref":"#/components/schemas/instance_event_action"},"user":{"$ref":"#/components/schemas/FlowUserId"},"document":{"$ref":"#/components/schemas/DocumentID"}},"type":"object"},"instance_event_action":{"description":"An event performed by a participant upon a document.","example":"sign","type":"string","enum":["approve","sign","view","reject","redirect"]},"FlowUserId":{"description":"A Flow user ID is an ID together with a type specifying\nwhat kind of an ID it is.\n\nThe reason for this is that Document signatories can be identified\nin several ways and we need to support them all.\n\nTypes `email`, `phone_number` and `full_name` can be specified if a\nsignatory is determined in one of these ways. `full_name` expects\nfirst name and second name to be connected together with space\nexactly in this order.\n\nIf a signatory is a Scrive user (this is the case for authors)\nwe can specify that using the `user_id` type.","oneOf":[{"title":"Email","required":["id_type","id"],"properties":{"id_type":{"type":"string","enum":["email"]},"id":{"type":"string"}},"type":"object"},{"title":"PhoneNumber","required":["id_type","id"],"properties":{"id_type":{"type":"string","enum":["phone_number"]},"id":{"type":"string"}},"type":"object"},{"title":"UserId","required":["id_type","id"],"properties":{"id_type":{"type":"string","enum":["user_id"]},"id":{"$ref":"#/components/schemas/UserID"}},"type":"object"},{"title":"FullName","required":["id_type","id"],"properties":{"id_type":{"type":"string","enum":["full_name"]},"id":{"type":"string"}},"type":"object"}],"example":{"id":"foo@example.com","id_type":"email"}},"admin_api_action":{"title":"admin_api_action","description":"Action which can be performed by the instance author.","oneOf":[{"title":"notify_participant","required":["action","participant_id"],"properties":{"action":{"type":"string","enum":["notify_participant"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"}},"type":"object"},{"title":"cancel_instance","required":["action"],"properties":{"action":{"type":"string","enum":["cancel_instance"]}},"type":"object"},{"title":"prolong_instance","required":["action","max_days"],"properties":{"action":{"type":"string","enum":["prolong_instance"]},"max_days":{"description":"Prolongation duration in days.","example":60,"type":"integer","maximum":365,"minimum":1}},"type":"object"},{"title":"reset_auth_attempts","required":["action","participant_id"],"properties":{"action":{"type":"string","enum":["reset_auth_attempts"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"},"auth_label":{"$ref":"#/components/schemas/AuthId"}},"type":"object"},{"title":"reset_authentication_attempts","required":["action","participant_id","authentication"],"properties":{"action":{"type":"string","enum":["reset_authentication_attempts"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"},"authentication":{"$ref":"#/components/schemas/AuthIdentifier"}},"type":"object"},{"title":"admin_form","required":["action","form_id","schema"],"properties":{"action":{"type":"string","enum":["admin_form"]},"form_id":{"$ref":"#/components/schemas/admin_form_id"},"schema":{"$ref":"#/components/schemas/Schema"},"ui_schema":{"$ref":"#/components/schemas/UiSchema"},"default_value":{"$ref":"#/components/schemas/form_data"}},"type":"object"},{"title":"complete_redirect","required":["action","participant_id","url"],"properties":{"action":{"type":"string","enum":["complete_redirect"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"},"url":{"$ref":"#/components/schemas/Url"}},"type":"object"},{"title":"modify_reminder_settings","required":["action","participant_id"],"properties":{"action":{"type":"string","enum":["modify_reminder_settings"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"}},"type":"object"},{"title":"delete_reminder_settings","required":["action","participant_id"],"properties":{"action":{"type":"string","enum":["delete_reminder_settings"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"}},"type":"object"},{"title":"cancel_reminder","required":["action","participant_id"],"properties":{"action":{"type":"string","enum":["cancel_reminder"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"}},"type":"object"},{"title":"modify_participant_info","required":["action","participant_id","invitations_sent","authentication_modifiable"],"properties":{"action":{"type":"string","enum":["modify_participant_info"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"},"invitations_sent":{"type":"array","items":{"$ref":"#/components/schemas/InvitationKind"},"uniqueItems":true},"authentication_modifiable":{"type":"boolean"}},"type":"object"}],"example":{"action":"notify_participant","participant_id":"78b4265b-e96e-4172-97b8-1144f6e71729"},"type":"object"},"AuthId":{"description":"Authentication ID to enable complex authentication schemas.","example":"authId","type":"string"},"AuthIdentifier":{"type":"string","enum":["view","view_archived","sign"]},"admin_form_id":{"title":"admin_form_id","description":"Admin Form ID","required":["id","participant_id"],"properties":{"id":{"type":"string","enum":["participant_form"]},"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"}},"example":{"id":"participant_form","participant_id":"78b4265b-e96e-4172-97b8-1144f6e71729"},"type":"object"},"Schema":{"description":"JSON Schema","example":{"description":"Fill in to provide your personal information.","properties":{"dateOfBirth":{"format":"date","type":"string"},"email":{"format":"email","type":"string"},"fullName":{"minLength":1,"type":"string"},"insurance":{"type":"boolean"}},"propertyOrder":["fullName","email","dateOfBirth","insurance"],"required":["fullName","email"],"title":"Personal details","type":"object"},"type":"object"},"UiSchema":{"description":"UI Schema","example":{"elements":[{"scope":"/properties/fullName","type":"Control"},{"label":"E-mail","scope":"/properties/email","type":"Control"},{"label":"Date of Birth","scope":"/properties/dateOfBirth","type":"Control"},{"scope":"/properties/insurance","type":"Control"}],"type":"VerticalLayout"},"type":"object"},"form_data":{"description":"Data from a filled-in form.","example":{"example_key":"example_value"}},"InvitationKind":{"type":"string","enum":["email","sms"]},"get_participant":{"title":"get_participant","required":["participant_id","dsl_name","tags","authentications","automatic_reminder"],"properties":{"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"},"dsl_name":{"$ref":"#/components/schemas/UserName"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/get_participant_tag"}},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/participant_authentication"}},"automatic_reminder":{"$ref":"#/components/schemas/automatic_reminder_detail"},"latest_reminder":{"description":"Timestamp of the most recent reminder sent to this participant, covering both manual, bulk and automatic reminders.","example":"2021-05-04T00:00:00Z","type":"string","format":"yyyy-mm-ddThh:MM:ssZ"}},"example":{"authentications":[{"label":"authId","max_attempts_reached":false,"parameters":{"attempts_per_sms":5,"mobile_number":null,"provider":"sms_otp"},"type":"standard"}],"automatic_reminder":{"date":"2026-01-15T09:30:00Z","settings":{"date":{"days_delay":7,"repeat":null,"time":null,"type":"relative"},"method":"email"}},"dsl_name":"user1","latest_reminder":"2021-05-04T00:00:00Z","participant_id":"78b4265b-e96e-4172-97b8-1144f6e71729","tags":[{"category":"full_name","value":"John Doe"},{"category":"email","value":"private.user@example.com"},{"category":"email","value":"corporate.user@example.com"}]},"type":"object"},"get_participant_tag":{"title":"get_participant_tag","description":"Object with participant information.\n\n**Note**: This value is for internal use only and subject to change without prior notice.","required":["category","value"],"properties":{"category":{"type":"string"},"value":{"type":"string"}},"example":{"category":"email","value":"user@example.com"},"type":"object"},"participant_authentication":{"title":"participant_authentication","oneOf":[{"title":"standard","required":["type","max_attempts_reached","parameters"],"properties":{"type":{"type":"string","enum":["standard"]},"label":{"$ref":"#/components/schemas/DeprecatedAuthId"},"max_attempts_reached":{"type":"boolean"},"parameters":{"$ref":"#/components/schemas/standard_parameters"}},"example":{"label":"authId","max_attempts_reached":false,"parameters":{"attempts_per_sms":5,"mobile_number":null,"provider":"sms_otp"}},"type":"object"},{"title":"sign","required":["type","max_attempts_reached","parameters"],"properties":{"type":{"type":"string","enum":["sign"]},"label":{"$ref":"#/components/schemas/DeprecatedAuthId"},"max_attempts_reached":{"type":"boolean"},"parameters":{"$ref":"#/components/schemas/sign_parameters"}},"example":{"label":"authId","max_attempts_reached":false,"parameters":{"attempts_per_sms":5,"mobile_number":"+46123456789","provider":"sms_otp"}},"type":"object"}],"example":{"label":"authId","max_attempts_reached":false,"parameters":{"attempts_per_sms":5,"mobile_number":null,"provider":"sms_otp"},"type":"standard"},"type":"object"},"DeprecatedAuthId":{"description":"Authentication ID to enable complex authentication schemas.\n\nThis field is deprecated and will be removed in the future.","example":"authId","deprecated":true,"type":"string"},"standard_parameters":{"title":"standard_parameters","oneOf":[{"title":"sms_otp","required":["provider"],"properties":{"provider":{"type":"string","enum":["sms_otp"]},"attempts_per_sms":{"description":"Limit to how many times the participant can input an incorrect OTP code they received in\nan authentication SMS. Once the limit is reached, the authentication attempt fails.","example":5,"default":5,"type":"integer","maximum":5,"minimum":1},"mobile_number":{"type":"string"}},"example":{"attempts_per_sms":5,"mobile_number":null},"type":"object"},{"title":"onfido","required":["provider"],"properties":{"provider":{"type":"string","enum":["onfido"]},"report":{"$ref":"#/components/schemas/onfido_report"},"allowed_document_countries":{"description":"List of document-issuing countries","type":"array","items":{"$ref":"#/components/schemas/OnfidoCountry"},"minItems":1,"uniqueItems":true},"allowed_document_types":{"type":"array","items":{"$ref":"#/components/schemas/onfido_document_type"},"minItems":1,"uniqueItems":true},"force_cross_device":{"description":"Force desktop users to use a mobile device to take photos.","default":true,"type":"boolean"},"additional_report_info":{"$ref":"#/components/schemas/onfido_additional_report_info"},"first_name":{"$ref":"#/components/schemas/OnfidoApplicantNameField"},"last_name":{"$ref":"#/components/schemas/OnfidoApplicantNameField"},"date_of_birth":{"$ref":"#/components/schemas/Day"},"email":{"type":"string"}},"example":{"additional_report_info":null,"allowed_document_countries":null,"allowed_document_types":["national_identity_card","driving_licence","passport","residence_permit"],"date_of_birth":null,"email":null,"first_name":null,"force_cross_device":null,"last_name":null,"report":"document"},"type":"object"},{"title":"se_bank_id","required":["provider"],"properties":{"provider":{"type":"string","enum":["se_bank_id"]},"personal_number":{"type":"string"}},"example":{"personal_number":null},"type":"object"},{"title":"dk_mit_id","required":["provider"],"properties":{"provider":{"type":"string","enum":["dk_mit_id"]},"personal_number":{"$ref":"#/components/schemas/MitIDCPR"},"company_number":{"description":"Danish CVR number.\n\nNumber with 8 digits, separated by any number of spaces, dashes, or new lines.","example":"12345678","type":"string"},"language":{"$ref":"#/components/schemas/mit_id_language"},"employee_login":{"type":"boolean"}},"type":"object"},{"title":"no_bank_id","required":["provider"],"properties":{"provider":{"type":"string","enum":["no_bank_id"]},"personal_number":{"type":"string"},"mobile_number":{"type":"string"},"allow_substantial_level":{"description":"Allow the use of BankID Biometric which provides the `Substantial` security level (instead of `High`). Please note that `certificateData` is `null` when this option is used.","default":false,"type":"boolean"},"ui_locale":{"$ref":"#/components/schemas/NOUiLocale"}},"type":"object"},{"title":"ftn","required":["provider"],"properties":{"provider":{"type":"string","enum":["ftn"]},"force_bank":{"$ref":"#/components/schemas/TupasBank"},"ui_locale":{"$ref":"#/components/schemas/UiLocale"},"personal_number":{"$ref":"#/components/schemas/FIPersonalNumber"}},"type":"object"}],"example":{"attempts_per_sms":5,"mobile_number":null,"provider":"sms_otp"},"type":"object"},"onfido_report":{"description":"Report / method to be used for identification","example":"document","default":"document","type":"string","enum":["document","document_and_photo","document_and_video","document_and_motion"]},"OnfidoApplicantNameField":{"description":"Has to be provided for Proof-of-Address report. It has to be at least two characters long and cannot contain the following characters: ^!#$%*=<>;{}\"","type":"string"},"Day":{"example":"2016-07-22","type":"string","format":"date"},"MitIDCPR":{"description":"Danish personal number (CPR-nummer)","type":"string","pattern":"^\\d{10}$"},"mit_id_language":{"example":"da","default":"da","type":"string","enum":["en","da","kl"]},"FIPersonalNumber":{"description":"Finnish personal number","type":"string","pattern":"^\\[0-9A-Z-+]{11}$"},"sign_parameters":{"title":"sign_parameters","oneOf":[{"title":"sms_otp","required":["provider"],"properties":{"provider":{"type":"string","enum":["sms_otp"]},"attempts_per_sms":{"description":"Limit to how many times the participant can input an incorrect OTP code they received in\nan authentication SMS. Once the limit is reached, the authentication attempt fails.","example":5,"default":5,"type":"integer","maximum":5,"minimum":1},"mobile_number":{"type":"string"}},"example":{"attempts_per_sms":5,"mobile_number":"+46123456789"},"type":"object"},{"title":"se_bank_id","required":["provider"],"properties":{"provider":{"type":"string","enum":["se_bank_id"]},"personal_number":{"$ref":"#/components/schemas/SEPersonalNumber"}},"type":"object"},{"title":"dk_mit_id","required":["provider"],"properties":{"provider":{"type":"string","enum":["dk_mit_id"]},"personal_number":{"$ref":"#/components/schemas/MitIDCPR"},"company_number":{"description":"Danish CVR number.\n\nNumber with 8 digits, separated by any number of spaces, dashes, or new lines.","example":"12345678","type":"string"},"language":{"$ref":"#/components/schemas/mit_id_language"},"employee_login":{"type":"boolean"}},"type":"object"},{"title":"no_bank_id","required":["provider"],"properties":{"provider":{"type":"string","enum":["no_bank_id"]},"personal_number":{"$ref":"#/components/schemas/NOPersonalNumber"},"mobile_number":{"type":"string"},"ui_locale":{"$ref":"#/components/schemas/NOUiLocale"}},"type":"object"},{"title":"onfido","required":["provider"],"properties":{"provider":{"type":"string","enum":["onfido"]},"report":{"$ref":"#/components/schemas/onfido_report"},"allowed_document_countries":{"description":"List of document-issuing countries","type":"array","items":{"$ref":"#/components/schemas/OnfidoCountry"},"minItems":1,"uniqueItems":true},"allowed_document_types":{"type":"array","items":{"$ref":"#/components/schemas/onfido_document_type"},"minItems":1,"uniqueItems":true},"force_cross_device":{"description":"Force desktop users to use a mobile device to take photos.","default":true,"type":"boolean"},"additional_report_info":{"$ref":"#/components/schemas/onfido_additional_report_info"},"first_name":{"$ref":"#/components/schemas/OnfidoApplicantNameField"},"last_name":{"$ref":"#/components/schemas/OnfidoApplicantNameField"},"date_of_birth":{"$ref":"#/components/schemas/Day"},"email":{"type":"string"}},"example":{"additional_report_info":null,"allowed_document_countries":null,"allowed_document_types":["national_identity_card","driving_licence","passport","residence_permit"],"date_of_birth":null,"email":null,"first_name":null,"force_cross_device":null,"last_name":null,"report":"document"},"type":"object"},{"title":"ftn","required":["provider"],"properties":{"provider":{"type":"string","enum":["ftn"]},"force_bank":{"$ref":"#/components/schemas/TupasBank"},"ui_locale":{"$ref":"#/components/schemas/UiLocale"},"personal_number":{"$ref":"#/components/schemas/FIPersonalNumber"}},"type":"object"}],"example":{"attempts_per_sms":5,"mobile_number":"+46123456789","provider":"sms_otp"},"type":"object"},"SEPersonalNumber":{"description":"Swedish personal number","type":"string","pattern":"^\\d{12}$"},"NOPersonalNumber":{"description":"Norwegian personal number","type":"string","pattern":"^\\d{11}$"},"automatic_reminder_detail":{"title":"automatic_reminder_detail","description":"Automatic reminder details for the participant.","properties":{"date":{"description":"The scheduled date for the participant's automatic reminder.","example":"2026-01-15T09:30:00Z","type":"string","format":"yyyy-mm-ddThh:MM:ssZ"},"settings":{"$ref":"#/components/schemas/participant_reminder_settings"}},"example":{"date":"2026-01-15T09:30:00Z","settings":{"date":{"days_delay":7,"repeat":null,"time":null,"type":"relative"},"method":"email"}},"type":"object"},"participant_reminder_settings":{"title":"participant_reminder_settings","description":"Automatic reminder settings for a participant.","required":["date","method"],"properties":{"date":{"$ref":"#/components/schemas/reminder_date"},"method":{"$ref":"#/components/schemas/ReminderDeliveryMethod"}},"example":{"date":{"days_delay":7,"repeat":null,"time":null,"type":"relative"},"method":"email"},"type":"object"},"ReminderDeliveryMethod":{"description":"Automatic reminder delivery method.","example":"email","type":"string","enum":["email","sms","email_and_sms"]},"status":{"description":"The execution status of the Flow instance.","example":"in_progress","type":"string","enum":["in_progress","finalising","canceled","rejected","completed","failed","timed_out"]},"initiator":{"description":"Who initiated the Flow instance.\n\n**Note**: This value is for internal use only and subject to change without prior notice.","type":"string","enum":["flow_api","id_check","journey_service"]},"start_draft":{"description":"Start a Flow draft.\n\nAll the request fields are optional.\n\nSetting any optionally nullable field to null removes its previous value.\n\nSetting the folder_id field will move the draft in that folder.\n","properties":{"title":{"$ref":"#/components/schemas/OptionalNullableField_Text"},"process":{"$ref":"#/components/schemas/FlowDSL"},"process_parameters":{"$ref":"#/components/schemas/process_parameters"},"callback":{"$ref":"#/components/schemas/OptionalNullableField_Callback"},"duration":{"title":"duration","description":"How long before an in-progress instance times out. It cannot exceed 365 days in total.","properties":{"days":{"type":"integer","maximum":365,"minimum":0},"hours":{"type":"integer","maximum":8760,"minimum":0},"minutes":{"type":"integer","maximum":525600,"minimum":0}},"example":{"days":15,"hours":7,"minutes":42},"default":{"days":90,"hours":null,"minutes":null},"type":"object"},"folder_id":{"$ref":"#/components/schemas/FolderID"}},"type":"object"},"start_instance":{"title":"start_instance","required":["process"],"properties":{"title":{"type":"string"},"process":{"$ref":"#/components/schemas/FlowDSL"},"process_parameters":{"$ref":"#/components/schemas/process_parameters"},"callback":{"$ref":"#/components/schemas/callback"},"duration":{"title":"duration","description":"How long before an in-progress instance times out. It cannot exceed 365 days in total.","properties":{"days":{"type":"integer","maximum":365,"minimum":0},"hours":{"type":"integer","maximum":8760,"minimum":0},"minutes":{"type":"integer","maximum":525600,"minimum":0}},"example":{"days":15,"hours":7,"minutes":42},"default":{"days":90,"hours":null,"minutes":null},"type":"object"},"folder_id":{"$ref":"#/components/schemas/FolderID"},"automatic_document_redirects":{"$ref":"#/components/schemas/automatic_document_redirects"},"accessible_duration":{"title":"duration","description":"How long before a successfully finished process becomes inaccessible for its participants. It cannot exceed 365 days in total.","properties":{"days":{"type":"integer","maximum":365,"minimum":0},"hours":{"type":"integer","maximum":8760,"minimum":0},"minutes":{"type":"integer","maximum":525600,"minimum":0}},"example":{"days":15,"hours":7,"minutes":42},"default":{"days":30,"hours":null,"minutes":null},"type":"object"},"language":{"$ref":"#/components/schemas/Lang"},"object_version":{"description":"Object version of the instance. The number is incremented whenever the instance is updated.","example":5,"type":"integer","format":"int64","maximum":18446744073709551615,"minimum":0},"single_document_process":{"type":"boolean"},"upcoming_documents":{"$ref":"#/components/schemas/upcoming_documents"}},"type":"object"},"automatic_document_redirects":{"description":"Automatic redirects on document actions.\n\nDefines if and when the participant will be automatically redirected to perform a document action. Participants are never redirected when they have a non-document action to perform.","default":"last_action","type":"string","enum":["last_action","always","never"]},"Lang":{"example":"en","type":"string","enum":["sv","en","de","fr","it","es","pt","nl","da","no","el","fi","is","et","lv","lt","cs","pl","hu"]},"upcoming_documents":{"description":"Configures how participants see documents that they cannot act on yet.\n\nWith the `hidden` option, a participant sees a document only when they can sign, approve or view it.\n\nWith the `visible` option, a participant also sees the documents of their future steps. These documents are\nshown as not yet available and the participant cannot open them.","default":"hidden","type":"string","enum":["hidden","visible"]},"event_prolong_instance":{"title":"event_prolong_instance","required":["days"],"properties":{"days":{"description":"Prolongation duration in days.","example":60,"type":"integer","maximum":365,"minimum":1}},"type":"object"},"event_notify_participant":{"title":"event_notify_participant","description":"Message to notify a participant.","required":["participant_id","method","message"],"properties":{"participant_id":{"description":"Unique identifier of the participant.","example":"78b4265b-e96e-4172-97b8-1144f6e71729","type":"string","format":"uuid"},"method":{"$ref":"#/components/schemas/NotificationMethod"},"language":{"$ref":"#/components/schemas/Lang"},"message":{"$ref":"#/components/schemas/Message"}},"example":{"language":"en","message":"e-mail message","method":"email","participant_id":"78b4265b-e96e-4172-97b8-1144f6e71729"},"type":"object"},"NotificationMethod":{"description":"Notification method","example":"email","type":"string","enum":["email","sms"]},"flow_data_retention_policy":{"title":"flow_data_retention_policy","properties":{"delete_trashed":{"description":"Number of days before deleting a trashed Flow instance.","example":30,"default":30,"type":"integer","maximum":365,"minimum":0},"trash_completed":{"description":"Number of days before trashing a completed Flow instance.","example":180,"type":"integer","maximum":365,"minimum":0},"trash_failed":{"description":"Number of days before trashing a failed, rejected, or canceled Flow instance.","example":90,"type":"integer","maximum":365,"minimum":0},"trash_timed_out":{"description":"Number of days before trashing a timed out Flow instance.","example":90,"type":"integer","maximum":365,"minimum":0}},"type":"object"},"version":{"description":"Flow service version information.","required":["api_version","build_date","build_commit","build_version"],"properties":{"api_version":{"type":"string"},"build_date":{"type":"string"},"build_commit":{"type":"string"},"build_version":{"type":"string"}},"example":{"api_version":"33","build_commit":"c6d6de264c","build_date":"20201128-124559","build_version":"3230323331"},"type":"object"}},"securitySchemes":{"OAuth1.0":{"type":"http","scheme":"oauth1","description":"A set of tokens which fulfill the requirements of the OAuth v1 scheme. These authorization credentials are the same as those used with the main Scrive API."},"OAuth2.0":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth2/auth","tokenUrl":"/oauth2/token","refreshUrl":"/oauth2/token","scopes":{"full":"Full access to users data","doc:check":"Ability to read users documents","doc:start":"Ability to start documents","doc:create":"Ability to create document as the user","openid":"Ability to user OpenID connect","offline_access":"Ability to get a refresh token"}}},"description":"OAuth2 security schemes"},"SessionCookie":{"name":"sessionId","in":"cookie","type":"apiKey","description":"Session cookie authentication. Secure cookie handled by your browser."},"XToken":{"name":"X-Scrive-XToken","in":"header","type":"apiKey","description":"Cross-Site Request Forgery protection token for non-GET requests. Retrievable from `xtoken` cookie when using session authentication."}}},"tags":[{"name":"Drafts","description":"This section contains endpoints related to Drafts."},{"name":"Instances","description":"This section contains endpoints related to Instances."},{"name":"Data Retention","description":"This section contains endpoints related to data retention.\n\nFlow instances are subject to Data retention on a folder basis. When setting a new policy for a folder or updating an existing one,\nonly new instances created in that folder will be affected and will be assigned the new policy. All existing instances will\nretain their previously assigned policy. Subfolders inherit retention policies except if they have one already set.\n\nData retention applies to instances which are no longer in progress.\n\nContact your Scrive representative to enable unlimited retention for your Flow instances, where no default values are set for missing policy fields.\n"},{"name":"No Auth","description":"This section contains endpoints which do not require any authentication to use."}],"openapi":"3.0.0"}