List

Overview

You can get all Workflow list assigned to you or shared with you by using this API.

API detail

Request

• URL: /workflows/
• Method: GET

Response

Success

• Status code: 200
• Body:

[
  {
    "id": 39,
    "document_sign_list": [
      {
        "id": 65,
        "signer_info": {
          "id": 1091,
          "email": "signer@gmail.com",
          "phone": "12345678900",
          "country_code": "US",
          "firstname": "Signer",
          "lastname1": "1",
          "lastname2": null,
          "rut": null
        },
        "signer": {
          "email": "signer@gmail.com",
          "firstname": "Signer",
          "lastname1": "1",
          "lastname2": null,
          "phone": "12345678900"
        },
        "flow_type": "priority",
        "sign_flow": "me",
        "sign_method": "certification",
        "anchor": null,
        "x1": 57,
        "y1": 423,
        "x2": 238,
        "y2": 483,
        "pageno": 1,
        "share_signed_document": false,
        "video_validation": false,
        "selfie_validation": false,
        "id_validation": false,
        "skip_email": false,
        "condition_field": null,
        "condition": null,
        "condition_value": null,
        "tablet_info": null
      }
    ],
    "name": "Workflow 1",
    "created_at": "2024-10-10T17:49:43.769710Z",
    "updated_at": "2025-03-10T14:50:20.963096Z",
    "owner": "owner.email@gmail.com",
    "user_list": [
        "shared.email@gmail.com"
    ]
},
],
...

• document_sign_list

Value	Type	Description
flow_type	str	Available values are priority, simultaneously. Default value is priority. If you set this value priority, document sign flow will flow one signer by one signer. This means document will be sent to next signer after completing the current signer's sign flow. If you set this value simultaneously, document will sent to all signer's at the same time, signers can sign document regardless other signers signed or not.
share_signed_document	bool	This parameter is to determine the email notification after sign. Default value is false. If you set this value as true, all signers will receive signed document email notification after sign process finished.
sign_flow	str	Sign flow type
sign_method	str	Sign method you wanna to use to sign document
video_validation	bool	To require the video validation of signer in Remote and Remote SMS method
selfie_validation	bool	To require the selfie validation of signer in Remote and Remote SMS
id_validation	bool	To require the Identity Documentation validation of signer in Remote and Remote SMS
x1, y1, x2, y2	float	Signature image position coordinate. (x1, y1) is the left bottom corner, (x2, y2) is the top right corner. Origin of coordinate is bottom left corner of document. Recommended ratio of width to height of signature image position is 3:1
pageno	int	Page number of document to insert the signature image in. The first page of document is 1.
anchor	str	The specific word in your document which you want to put the signature image on. The start point of anchor text will be the top left corner of the signature image. The sign image size will be 180 * 60 px rectangle by default.

• sign_flow

Available value	Available sign methods	Description
me	certification, local_certificate, sms, no_sms	Sign by myself, this means document will be signed by you. In this flow, you are the signer of document
other	sms, no_sms	Sign by other person, this means document will be signed by other person, not by legale user.
legale	certification, no_certification	Sign by legale user, this means document will be signed by other legale user.
approve	approve, approve_legale, approve_api	This flow is to approve document by some persons, not adding digital signature into document, just approve current document sign flow by person.
tablet	tablet_sign	This flow is to send document to tablet, on the tablet, you can add fingerprint into the document.
signing_portal	signing_portal	This flow is to send document to sign in signing portal.
dynamic_signer	no_sms, sms	This flow is to send document to sign to dynamic signer, signer will be got from smart form.

• sign_method

Available value	Available sign flows	Description
sms	me, other	Sign document using Remote SMS, signer will receive the sign request through his email. In this case, phone number is required, otherwise signer will not be able to receive OTP
no_sms	me, other	Sign document using Remote, in this case, signer will receive the sign request through his email. No need to pass the phone number
certification	me, legale	Sign document using cloud certificate, in this case, signer can be you or other legale person. Signer will receive sign request in his legale account
no_certification	legale	Sign document using other sign method such as Remote or Remote SMS, in this case, signer can choose his sign method except certification. Signer will receive sign request in his legale account
local_certificate	me	Sign document using local certificate, in this case, signer can be you or other legale person. Signer will receive sign request in his legale account. Signer should have his local certificate. This method is working on only Windows 10 for now.
approve	approve	This is not digital sign. This method will send document to approver to approve current flow by himself. Approver is not legale user in this case.
approve_legale	approve	This is not digital sign. This method will send document to approver to approve current flow by himself. Approver should be legale user in this case.
approve_api	approve	This is not digital sign. You will receive a url from API response in this method, after that, you can approve that document by sending a new POST request to that url.
tablet_sign	tablet	This is sign method to document to sign in mobile device.
signing_portal	signing_portal	This is sign method to document to sign in signing portal. After start sign process, you can search and sign the documents from here.