Skip to main content

Flow API Release notes

Version 6​

Introduce Flow Instance Attachments.

Attachments are PDF files that do not need to be signed or approved by any participant. They can be assigned to individual signatories at any stage of the process. Attachments can be marked as mandatory for some participants, in which case the participants need to acknowledge they received the attachment PDF files.

Version 5​

Add FTN as a new authentication provider.

Version 4​

  • Allow viewing documents for all viewer participants, i.e. document parties which are neither signatories nor approvers.
  • Send default invitations to all viewer participants when the process is started.
  • Send default invitations to participants when they are first asked to fill a form.
    • Before, participants were invited only when first signing or approving a documents.

Version 3​

Introduce accessible_duration setting.

The new setting controls when a process becomes inaccessible for its participants.

Version 2​

Introduce Forms. See the Forms documentation page for details.

Version 1​

Major feature release. The following changes were made to the Create Instance end-point:

  • "settings" property has been added with various optional settings to customize instance behavior:

    • "automatic_document_redirects" to automatically redirect participants to the next document to be signed
    • "callback" setting to set the target URL for callbacks
    • "messages" to switch off implicit invitations and confirmations. A more flexible alternative is now available in the "process" property.

  • Some instance settings were deprecated and moved into "settings":

    • "duration"
    • "language"

  • "process" property now support several new step types:

    • "send_sms" and "send_email" as flexible alternatives to implicit invitations and confirmations.
    • "seal" for early document sealing.
    • "redirect" to redirect a participant to an external URL.
    • "callback" to send a custom callback.

  • Introduce onfido as a sign/view authentication provider.

Version 0​

Initial release of the Flow API. It offers the following:

  • create new Flow instance endpoint;
  • endpoints for managing existing instances, like trashing or deleting them, or prolonging their timeout dates;
  • endpoint for notifying a participant of an instance; and
  • data retention endpoints for setting policies for handling data of finished instances.

Creating a Flow instance​

The Flow instances created through this API support the following:

  • signing or approving one or more documents at the same time, by any number of participants;
  • document rejection;
  • combining instance steps in sequence or in parallel;
  • implicit invitation and confirmation e-mails and/or SMSs sent to participants;
  • verification of participants' identity when accessing their instance Overview page through first-party SMS OTP, or third-party providers: Swedish BankID, Danish MitID, or Norwegian BankID; and
  • verification of participants' identity when signing documents through first-party SMS OTP, Click-to-Sign, or third-party providers: Swedish BankID, Danish MitID, or Norwegian BankID.