Skip to main content
Kofax

Kofax SignDoc 1.3.0 - SMS Plugin Step By Step using REST API

Summary

This description outlines, how the SMS notification feature can be used with KSD 1.3.0 and the REST API. There is a known Bug in the v4 REST API in KSD 1.3.0 that prevents a user to create a SigningPackage including SMS Notification information in one step. The workaround is, to set this information in a separate step. 13680

Step 1 - Load Plugin:

using ksdadmin credentials, set configuration settings with the following json object:

{
    "list": [{
            "k": "plugin.loadlist",
            "v": "de.softpro.cirrus.plugins.notification.NotificationSMSClickatell"
        }
    ]      
}

Step 2 - Enable Plugin for Account:

using ksdadmin credentials and filling the account id, set configuration settings with the following json object:

{
        "list": [{
                        "k": "plugin.enabled.NotificationSMSClickatell",
                        "v": "true"
                }
        ]
}

Step 3 - Create Signing Package:

using a user with ADMIN role credentials, create a signing package with the following json object:

{
        "name": "Template with 1 document for 1 signer and authentication",
        "description": "Template with 1 document for 1 signer and authentication",
        "mailSubject": "MailSubject - A request via Kofax SignDoc",
        "mailMessage": "MailMessage - You are invited to sign",
        "signingModeOptions": ["HW"],
        "type": "TEMPLATE",
        "documents": [{
                "id": "SigningPackage001",
                "name": "Simple Doc 1",
                "fileName": "SimpleDoc_1.pdf",
                "format": "PDF",
                "content": "JVBERi0xLjMKJcT… THE_BASE64_ENCODED_DOCUMENT ...
NTQKJSVFT0YK",
                "signatureFields": [{
                                "id": "signature-1",
                                "page": 1,
                                "height": 50,
                                "width": 150,
                                "posx": 90,
                                "posy": 670,
                                "required": "true",
                                "label": "Signature Field 1",
                                "signerId": "signer-1",
                                "signingModeOptions": ["HW"]
                            }
                    ]
            }
    ],
    "signers": [{
                    "id": "signer-1",
                    "name": "Liane",
                    "role": "SIGNER",
                    "email": "local_user02@loc-team.com"
            }
    ]
}

Step 4 - Set SMS information:

using a user with ADMIN role credentials, update the signer of the newly create signing package with the following json object:

{
    "authenticationMode": "CODE",
    "authenticationParam": "54321",
    "accessCodeDeliveryPluginId": "NotificationSMSClickatell",
    "accessCodeDeliveryParameters": [{
            "key": "NotificationSMSClickatell.phonenumber",
            "value": "+49-1604788520"
        }
    ]
}

Note: step 4 needs to be called separately only in versions prior to 1.3.1. Otherwise the information of the structure from step 4 can be used inside the signer information structure from step 3.

Keywords: Kofax SignDoc SMS

  • Was this article helpful?