Skip to main content

Specification Changelog

Complete list of changes:​

0.42.0 Add new FTN provider​

  • Add ftn as a new authentication provider.

0.41.0 Add new Onfido authentication methods​

  • Onfido auth_to_view and auth_to_view_archived now support two new methods:

    • "method": "document_and_video"
    • "method": "document_and_motion"

  • The default attempts_per_sms limit for SMS OTP authentications is changed to 5. It previously defaulted to 3.

0.40.0 Introduce accessible_duration.​

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

0.39.0 Introduce Automatic document redirects setting.​

  • The new setting controls how or if the participant will be automatically redirected to signview after each action (sign or approve). The available settings are:
    • "last_action": The participant will be automatically redirected to signview if they have only one document action remaining. This is the default setting.
    • "always": The participant will be automatically redirected to signview after each action
    • "never": The participant will never be automatically redirected to signview

0.38.0 Introduce Flow data retention endpoints.​

  • Add endpoints for getting/setting and deleting data retention policy for Flow instances.

0.37.0 Add documents field to get instance response​

  • Add a new documents field to the response of the "Get Instance" endpoint. The new field contains the list of documents ids associated with the instance.

0.36.0 Deprecate list calls​

  • Removed the "Get all Flow instances for user" API end-point from our public API. No compatibility will be guaranteed for this API call going forward.
    • This call had the potential to return excessive amounts of data if many instances existed for the given API user. This could cause request time-outs and/or server overload.

0.35.0 Hotfix list calls​

  • List calls have been limited to return a maximum of 10,000 last instances, because excessively long instance lists lead to timeouts and/or server errors. We are working on a more principled way to list Flow instances.

0.34.0 Add start instance end-point​

  • Add an end-point for starting an instance without first creating a draft.

0.33.0 Add allow-rejections options​

  • Adds the allow-rejections DSL option that controls whether the participants can reject the process via the overview page or not. Participants are still able to reject the process by rejecting individual documents even when allow-rejections options is set to false.

0.32.0 Add end-point for prolonging instance time out​

  • Add a new end-point to prolong in progress or timed out instances (documentation).

0.31.0 Add end-point for the author to send reminder notifications to participants​

  • Add an end-point to send reminder notifications to participants (documentation).
  • Add two new elements to theGet a Flow instance end-point:
    • "admin_actions" list which advertises which reminders can be sent. This list will expand to contain new administrative actions as we implement them.
    • "participants" list which contains the association of participant names in the DSL with Participant IDs, which can be used to send reminders to the correct participant. More data will be added to participants in the future.
  • Adds the new duration parameter to Flow drafts. The parameter sets the expected timeout date of the instance in days after the draft has been started and can be an integer between 1 - 365.

0.30.0 Remove use_micro_api parameter​

  • Remove the optional use_micro_api parameter from the start draft endpoint.

0.29.0 Remove sms_pin​

  • Remove the deprecated sms_pin authentication provider.

0.28.0 Allow multiple notification actions in confirmation stages​

  • Add the possibility to specify multiple notification actions to allow some recipients to receive confirmation via SMS, some via Email and some with Email and SMS.

0.27.0 Add WIP timed_out status, rejection bugfix and limiting max_failures​

  • Adds new timed_out status to Flow instances (WIP).
  • Fixed a bug where on document and instance rejection, some in_progress documents would not get canceled. Now, all remaining in_progress documents are canceled.
  • Authentication max_failures is now limited to a range of 0 to 255.

0.26.0 Add canceled to Flow instance status​

  • Adds new canceled status for Flow instances. Canceled processes will now use the canceled status instead of failed.

0.25.0 Add sms_otp, deprecate sms_pin​

Deprecation notice: The sms_pin authentication provider will be removed on 1 September 2022.

  • Add a new authentication provider: sms_otp, intended to replace sms_pin. The new provider includes an option to specify the number of failed attempts per sms. The existing max_failures option specifies total number of sms the user will receive per authentication attempt. If the option is not provided, the number of attempts per sms defaults to 3.

0.24.0 Add new EID Service endpoints for MicroApi Flows​

  • Add the start and check EID service endpoints for authentication in MicroApi Flow processes.

0.23.0 Add trashing restoring and deleting Flow instances​

  • Flow instances can now be trashed, restored and deleted by the instance author. More information can be found at the API documentation for the relevant endpoints.
  • Instances retrieved for a user can now be filtered with the trashed filter.

0.22.0 revert the introduction of the schemaref endpoint​

  • Remove the schemaref endpoint in favor of manually configured Flow payload schemas.

0.21.0 schemaref endpoint and Custom callbacks​

  • Add schemaref endpoint to retrieve a JSON schema that can be used for writing and validating Flow API requests.
  • Add a callback action to the DSL to allow custom callbacks to be defined per stage.

0.20.0 Improve redirect-to expect conditions.​

Incompatibility notice: This update invalidates uses of redirect-to expect conditions with users that do not have document actions in this stage.

This includes stand alone redirect-to stages. For examples on valid use of redirect-to expect conditions, please see the Flow documentation.

  • Redirect participants at the end of their document actions in a stage

0.19.1 Add basic callback authentication​

  • callback field in the endpoints for manipulating Flow drafts has been extended to accept an optional "auth" key.

0.19.0 Add NemID and MitID as authentication to view methods​

  • Add new authentication to view provider methods "dk_nemid", "dk_mitid" and "dk_mitid/nemid".

0.18.1 Retirement of viewed-by​

Deprecation notice: The viewed-by condition will be removed from the DSL on 7 March 2022.

Please use the new allow-viewing and deny-viewing actions instead.

0.18.0 Add viewing permissions to MicroApi based flows.​

  • Add allow-viewing and deny-viewing actions to the DSL. These allow you to set document viewing permissions for participants in a Flow. This functionality is available only for flows that use MicroApi.

0.17.1 Onfido allowed document countries​

  • Add allowed_document_countries to Onfido AuthenticationConfiguration schema.

0.17.0 Add External redirections​

  • Add redirect-to to the DSL's Expect schema.
  • The DocumentID in InstanceUserEvent and InstanceUserActionForAuthor datatypes are now optional.

0.16.0 Retirement of Templates API​

Deprecation notice: Templates API will be retired on 22 November 2021.

Features that will be removed on 22 November 2021:

  • Remove all /templates endpoints, i.e. createTemplate, deleteTemplate, getTemplate, patchTemplate, listTemplates, commitTemplate, startTemplate and validateTemplate
  • Schema InstanceGetResponse: remove fields template_id and template_parameters

0.15.0 Signing groups (K of N)​

  • Add approved-by-group-of and signed-by-group-of to the DSL's Expect schema

0.14.3 Add Flow instance cancellation callback​

  • Add callback event for Flow cancellation

0.14.2 Remove instance id from the internal /view endpoint​

  • Schema GetInstanceView: remove the id field

0.14.1 Onfido date of birth and additional report information​

  • Enable Onfido date of birth validation for signatories with the DoB field.
  • Schema AuthenticationOnfido: add optional additional_report_info field.

0.14.0 Drafts API​

  • Add /drafts/* endpoints. Drafts API provides an alternative to the existing Templates API.

0.13.7 Swedish BankID authentication in flow​

  • New authentication provider "se_bankid". See AuthenticationSeBankId object fore more details.

0.13.6 Preparation for drafts API​

Changes to InstanceGetResponse schema:

  • Add process and process_parameters.
  • Deprecation notice: template_id is now optional and will be removed as of the September 1, 2021.
  • Deprecation notice: template_parameters will be removed as of the September 1, 2021. Use process_parameters instead.

0.13.5 Full name identification​

  • Add Flow full_name as id_type.

0.13.4 Support Onfido authentication from Desktop​

  • Add support for allowing Onfido authentication from a mobile device only or from both mobile and desktop.

  • Schema AuthenticationOnfido: add optional document_capture field.

0.13.3 Confirmation messages​

  • Add new confirmation stage, see: FlowDslConfirmationStage.
  • Deprecation notice: Per document confirmations will be removed as of the September 1, 2021, use FlowDslConfirmationStage instead.
  • Remove the link field from /view endpoint previous_events objects due to a refactoring.
  • Add new link field to the /view endpoint previous_events objects. (Will likely be removed in an upcoming refactor).
  • Correct InstanceUserAction definition (action_link field is actually called link).

0.13.0 New finalising state​

  • Add new instance status finalising

0.12.1 Improve Flow callbacks​

  • Add eid_transaction_id to CallbackEventAuthenticationAttemptedVersion1 callback event.

0.12.0 Improve Flow author handling and access control​

  • Endpoint GET /instances: return all instances created by the current API user (breaking change).
  • Schema TemplateCreateRequest: add optional field folder_id.
  • Schema TemplateResponse: add field author_id.
  • Schema InstanceCreateRequest: add optional field folder_id.
  • Schema InstanceGetResponse: add fields author_id and folder_id.
  • Improved access controls rules (for internal use only).

0.11.3 Add template created date to response​

  • Add created date and time to the TemplateResponse schema.

0.11.2 Improve internal endpoint for viewing instances by participants​

  • Update the InstanceViewResponse schema to include the participants's previous actions and correctly report the state of all their documents.
  • Remove InstanceUserState schema.
  • Add InstanceUserEvent schema.
  • Schema InstanceUserAction: rename document field to document_id.

0.11.1 Improve error documentation​

  • Added documentation for details field in error responses.

0.11.0 Add cancel endpoint for instances​

  • New /cancel endpoint added to allow the flow author to withdraw the flow and all its unsealed documents.
  • Change to the error code for the reject endpoint when not able to reject the flow due to state already being failed or cancelled.

0.10.8 Support more Onfido settings​

  • Add support for specifying allowed document types when using Onfido for authentication.
  • Schema AuthenticationOnfido: add optional allowed_document_types field.
  • Schema VersionResponse: add fields api_version and build_date.

0.10.7 Support SMS OTP authentication provider​

  • Add support for SMS OTP (one-time password) authentication via EID Hub.

0.10.6​

  • Add support for specifying which method when using Onfido for authentication.
  • Schema AuthenticationOnfido: add optional method field.

0.10.5​

  • Add message parameter for flow instance rejection API.
  • Send flow_rejected callback event when a flow instance is rejected.

0.10.4​

  • Add CallbackEventFailedVersion1 schema.
  • Add POST /instances/{instance_id}/reject for rejecting a flow instance.
  • Start sending completed and failed events. See the API guide for details.

0.10.3​

Add specification of callback events.

  • Add CallbackEvent schema.
  • Add CallbackEventVersion1 schema.
  • Add CallbackEventBaseVersion1 schema.
  • Add CallbackEventCompletedVersion1 schema.
  • Add CallbackEventFlowRejectedVersion1 schema.
  • Add CallbackEventAuthenticationAttemptedVersion1 schema.
  • Add OnfidoProviderDataVersion1 schema.

0.10.2​

Add authentication configuration. The authentication functionality itself is not implemented yet.

  • Add optional (per user) authentication settings in POST /templates/{template_id}/start
  • Add UserConfig and AuthConfig schemas.
  • Modify TemplateParameters schema: the users property now accepts UserConfig objects. This change is backwards-compatible and RichUserIds are also accepted.

0.10.1​

Add callback configuration. The callback functionality itself is not implemented yet.

  • Schema InstanceCreateRequest: add field callback.
  • Schema InstanceGetResponse: add field callback.

0.10.0​

  • DSL spec has been modified. Notification methods must be specified (email and/or sms) rather than simply a message.
  • Require that dsl-version be equal to "0.2.0".

0.9.2​

  • Add GET /documentation endpoint that presents the API specification.
  • Add a more detailed specification description.
  • Fix specification metadata.
  • Remove unused schemas InstanceStage, InstanceEvent, InstanceEventAction.

0.9.1​

  • Add GET /version endpoint that presents Flow service version information.
  • Add VersionResponse schema.

0.9.0​

  • New fields added to the return JSON of GET /instances/{instance_id} and GET /instances/{instance_id}/view depicting the user-provided title, the start time and last event time of the flow instance.
  • Breaking change: Request JSON spec of POST /templates/{template_id}/start altered. The previously-required object is pushed down into the template_parameters object and the root object can now take an optional title parameter that allows for a human-readable name to be provided.

0.8.0​

  • Endpoint GET /templates/validate: return 204 on success.
  • Schema InstanceGetResponse: rename field template to template_id

0.7.0​

  • Schema InstanceState: remove field history.
  • Schema InstanceStage: add required field status.

0.6.3​

  • Schema InstanceUserAction: add required field action_link.

0.6.2​

  • Add SignatoryId schema.
  • Replace DocumentOverview schema by InstanceUserDocument.
  • Schema InstanceUserDocument: add required field signatory_id.
  • Schema InstanceUserAction: add required field signatory_id.

0.6.1​

  • Replace InstanceIdObject schema by InstanceGetResponse.
  • Schema InstanceGetResponse: add access_links field.

0.6.0​

  • Require that dsl-version be equal to "0.1.0".
  • Remove DSL action close.
  • Remove FlowDslClose schema.

0.5.0​

  • Add required field dsl-version to the DSL.
  • Schema InstanceEvent: rename deed field to action.
  • Rename InstanceEventDeed schema to InstanceEventAction.

0.4.4​

  • Add GET /instances endpoint for listing instances created by the user.

0.4.3​

  • Schema ErrorResponse: make explanation field optional.