Welcome Developers

Welcome Developers

Getting started with the REST API


The SigniFlow JSON API is intended to manage the initiation, cancellation and removal of document workflows created within the SigniFlow system. The API will also manage the security control within the SigniFlow system and generation of workflow steps. The API is hosted within the following location, Development Environment: https://preprod.signiflow.com/

Getting started with the REST API


The SigniFlow JSON API is intended to manage the initiation, cancellation and removal of document workflows created within the SigniFlow system. The API will also manage the security control within the SigniFlow system and generation of workflow steps. The API is hosted within the following location, Development Environment: https://preprod.signiflow.com/

The Basics


workflow

Creating a workflow is the core of SigniFlow there are multiple ways in which you can
create a workflow but the most simple way is displayed here:

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

CreateWorkflow ->Pass Through: Your API Token, Your Document (Base64 Encoded) & Other Information About The Workflow.
->Receive Back a Document ID

AddWorkflowStep ->Pass Through: The Document ID, Your API Token & Information About The Person Being Added.
->Receive Back Data Regarding The Step Added.

DocPrepperAddFields ->Pass Through: The Document ID, Your API Token & Information About The Field Being Added.
->Receive Back Data Regarding The Field Added.

InitiateFlow ->Pass Through: The Document ID, Your API Token
->Receive Back Data Regarding The Workflow.


Creating a workflow is the core of SigniFlow there are multiple ways in which you can
create a workflow but the most simple way is displayed here:

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

CreateWorkflow ->Pass Through: Your API Token, Your Document (Base64 Encoded) & Other Information About The Workflow.
->Receive Back a Document ID

AddWorkflowStep ->Pass Through: The Document ID, Your API Token & Information About The Person Being Added.
->Receive Back Data Regarding The Step Added.

DocPrepperAddFields ->Pass Through: The Document ID, Your API Token & Information About The Field Being Added.
->Receive Back Data Regarding The Field Added.

InitiateFlow ->Pass Through: The Document ID, Your API Token
->Receive Back Data Regarding The Workflow.


Keep A Backup Of Your Documents As They Are Updated Or Completed, Feel Safe Knowing SigniFlow Keeps A Full Audit Of All Actions Taken On A Document Which Allows Us To Verify Any Downloaded Document With Our Backup.

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

GetDoc ->Pass Through: Your API Token, Your Document ID.
->Receive Back a Document As A Base64 Encoded String As
Well As Other Information About The Document.


Doc prepper

Keep A Backup Of Your Documents As They Are Updated Or Completed, Feel Safe Knowing SigniFlow Keeps A Full Audit Of All Actions Taken On A Document Which Allows Us To Verify Any Downloaded Document With Our Backup.

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

GetDoc ->Pass Through: Your API Token, Your Document ID.
->Receive Back a Document As A Base64 Encoded String As
Well As Other Information About The Document.


Dashboard

Get Your Dash Board Information


Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

GetPrepperTemplateList ->Pass Through Your API Token.
->Receive Back All Of Your Dashboard Values Including How Many
Documents You can Still Create.

Get Your Dash Board Information


Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

GetPrepperTemplateList ->Pass Through Your API Token.
->Receive Back All Of Your Dashboard Values Including How Many
Documents You can Still Create.

SigniFlow RESTful API

The SignIFlow JSON API is intended to manage the initiation, cancellation and removal of document workflows created within the SigniFlow system.

The API will also manage the security control within the SigniFlow system and generation of workflow steps.

The API is hosted within the following location:

  • Development environment

The following protocol can be used to communicate with the exposed web service:

  • JSON POST
Click here to view our API service descriptions
GO TO EXAMPLE METHODSFull help file with example payloads

Try Our Login Example Method:


Url: https://flow.signflow.co.za/API/SignFlowAPIServiceRest.svc/Login

HTTP Method: POST

REQUEST: JSON
RESPONSE: JSON

JSON REQUEST SAMPLE:
{
	"PasswordField":"password",
	"UserNameField":"username"
}

JSON RESPONSE SAMPLE:
{
	"ResultField":"success",
	"TokenField":{
		"TokenExpiryField":"\/Date(928142400000+0200)\/",
		"TokenField":"15625"
	}
}

Code By Coders

Other Basic Implementations


Other Basic Implementations


Fetch All Prepper Templates


Get All Your PrepperTemplates To Allow You To Select One To Apply To A WorkFlow.

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

GetPrepperTemplateList ->Pass Through A Template Folder ID And Your API Token.
->Receive Back A List Of Prepper Templates.



basic implementations

Fetch All Prepper Templates


Get All Your PrepperTemplates To Allow You To Select One To Apply To A WorkFlow.

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

GetPrepperTemplateList ->Pass Through A Template Folder ID And Your API Token.
->Receive Back A List Of Prepper Templates.

Doc prepper template

Creating a Workflow with a Doc Prepper Template


Creating a workflow is the core of SigniFlow there are multiple ways in which you can
create a workflow but the most simple way is displayed here:

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

Create Docflow ->Pass Through: Your API Token, Your Document (Base64 Encoded) & Other Information About The Workflow.
->Receive Back a Document ID

AddWorkflowStep ->Pass Through: The Document ID, Your API Token & Information About The Person Being Added.
->Receive Back Data Regarding The Step Added.

ApplyPrepperTemplate ->Pass Through: The Document ID, Your API Token & a Template ID.
->Receive Back Data Regarding The Field Added.

InitiateFlow ->Pass Through: The Document ID, Your API Token
->Receive Back API Token from the login API.




Creating a workflow is the core of SigniFlow there are multiple ways in which you can
create a workflow but the most simple way is displayed here:

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

Create Docflow ->Pass Through: Your API Token, Your Document (Base64 Encoded) & Other Information About The Workflow.
->Receive Back a Document ID

AddWorkflowStep ->Pass Through: The Document ID, Your API Token & Information About The Person Being Added.
->Receive Back Data Regarding The Step Added.

ApplyPrepperTemplate ->Pass Through: The Document ID, Your API Token & a Template ID.
->Receive Back Data Regarding The Field Added.

InitiateFlow ->Pass Through: The Document ID, Your API Token
->Receive Back API Token from the login API.



Advanced Implementations




Workflows in two steps

Creating a workflow in two steps


Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

FullWorkflow ->Pass Through: Your API Token, Your Document (Base64 Encoded),
All Users Who Will Be Included In The Workflow as well as Where their
fields should be placed & Other Information About The Workflow.
->Receive Back a Document ID and Other Information Regarding The
Workflow.



Finding The Position Of Your Fields


If You Are Not Sure Where Your Fields Should Be Placed, Place White Text Wher You Want Your Field To Be.

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

CreateWorkflow ->Pass Through: Your API Token, Your Document (Base64 Encoded) & Other Information About The Workflow.
->Receive Back a Document ID

GetDocumentTagField -> Pass Through The Document ID, The Text To Search For And API Token.
-> Receive Back List Of Positions Where The Text Was Found.



API workflows

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

FullWorkflow ->Pass Through: Your API Token, Your Document (Base64 Encoded),
All Users Who Will Be Included In The Workflow as well as Where their
fields should be placed & Other Information About The Workflow.
->Receive Back a Document ID and Other Information Regarding The
Workflow.



Finding The Position Of Your Fields


If You Are Not Sure Where Your Fields Should Be Placed, Place White Text Wher You Want Your Field To Be.

Login -> Pass Through Your API Account Username And Password.
-> Receive Back a Token Which Is Used For Further Processes.

CreateWorkflow ->Pass Through: Your API Token, Your Document (Base64 Encoded) & Other Information About The Workflow.
->Receive Back a Document ID

GetDocumentTagField -> Pass Through The Document ID, The Text To Search For And API Token.
-> Receive Back List Of Positions Where The Text Was Found.



SigniFlow Signature API

Turn your online application into its own cryptographic signature engine and have your customers sign online in your App.

The fastest cryptographic signature API on the market. The ‘Signature API’ is a high-speed, convenient, purpose-built API that can be integrated with any web service where it is required for the signatory to digitally sign a document, using a third-party application.

Unlike standard SigniFlow APIs the ‘Signature API’ does not utilise standard SigniFlow functions, workflow engine functions or the standard SigniFlow user-authentication process. Instead, it relies on the third-party application to perform certain - or all of these - functions, and pass the information (trust) to the ‘Signature API’, which will use the trust data received from the application to cryptographically sign the document and embed said information in the digital signature.

Trust in the form of authentication is transferred to the third-party application by reference, and only the signature operation is performed by the Signature API. It is therefore expected that the application performs multi-factor authentication of the user, before calling the API.

Visit the Signature API Help PageDownload latest Docs and Code snippets

SigniFlow Academy


Learn How SigniFlow Works By Exploring
The Application Through It's User Interface


Start Learning