| POST | /SmartTag/Send | Send smart tag document. See detailed documentation for Smart Tag. | Send a smart tag document. See detailed documentation for Smart Tag. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QueueReference | model | string | No | Queue reference |
| DocumentReferences | model | array | Yes | document reference |
| Embedded | model | boolean | No | Shows if embedded signing |
| DueDate | model | string | Yes | Due date that document are to be signed by. |
| GMT | model | string | No | GMT Offset |
| EmailTemplateReference | model | string | No | Invitation Email template reference; Obsoleted, use InvitationEmailTemplateReference instead. |
| InvitationEmailTemplateReference | model | string | No | Invitation Email template reference, if not set, use the user default one. |
| CompletionEmailTemplateReference | model | string | No | Completion Email template reference, if not set, use the user default one. |
| WorkflowReference | model | string | No | Workflow reference |
| ReturnUrl | model | string | No | Return Url |
| Signers | model | array | No | Signer details, overwrite details populated in document |
| ListItems | model | array | No | The list options for drop down list field smart tag |
| NoPackage | model | boolean | No | Whether all documents are in a package (by default) or sent separately |
| SingleDocumentAsPackage | model | boolean | No | Create a package even if only one document |
| NotifyUrl | model | string | No | Notify Url |
| PackageName | model | string | No | The name of the package; if empty and only one document in package, the name will be document name. |
| ShareUsers | model | array | No | Share user details, if no share user specified in document |
| NoInvitationEmailTemplate | model | boolean | No | if true, use Secured Signing default template instead, ignore any template settings |
| NoCompletionEmailTemplate | model | boolean | No | if true, use Secured Signing default template instead, ignore any template settings |
| Supervising | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Embedded | form | boolean | No | Shows if embedded signing only for this invitee |
| ReturnUrl | form | string | No | Return Url only for this invitee |
| EmailTemplateReference | form | string | No | Invitation email template reference only for this invitee; Obsolete, use InvitationEmailTemplateReference instead; |
| InvitationEmailTemplateReference | form | string | No | Invitation email template reference only for this invitee |
| CompletionEmailTemplateReference | form | string | No | Completion email template reference only for this invitee |
| IsPersonalMessage | form | bool | No | Tell if the InvitationText is for personal message or customized email template |
| InvitationText | form | string | No | Customized email invitation text |
| EmailSubject | form | string | No | Customized email subject |
| Attachments | form | List<string> | No | The reference of attachments |
| NoInvitationEmailTemplate | form | boolean | No | if true, use Secured Signing default template instead, ignore any template settings |
| NoCompletionEmailTemplate | form | boolean | No | if true, use Secured Signing default template instead, ignore any template settings |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MobileNumber | form | string | No | Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc |
| MobileCountry | form | string | No | Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc |
| ShareUsers | form | List<ShareUser> | No | |
| ClientReference | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | Yes | First name of user |
| MiddleName | form | string | No | Middle name of user |
| LastName | form | string | Yes | Last name of user |
| form | string | Yes | Email address of user |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsDefault | form | bool | No | |
| IsOwner | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientField | form | string | Yes | The field name on client side |
| Item | form | string | Yes | Item name |
| Value | form | string | Yes | Item value |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /SmartTag/Send HTTP/1.1
Host: api.securedsigning.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"QueueReference":"String","DocumentReferences":["String"],"Embedded":false,"DueDate":"String","GMT":"String","EmailTemplateReference":"String","InvitationEmailTemplateReference":"String","CompletionEmailTemplateReference":"String","WorkflowReference":"String","ReturnUrl":"String","Signers":[{"Embedded":false,"ReturnUrl":"String","EmailTemplateReference":"String","InvitationEmailTemplateReference":"String","CompletionEmailTemplateReference":"String","IsPersonalMessage":false,"InvitationText":"String","EmailSubject":"String","Attachments":["String"],"NoInvitationEmailTemplate":false,"NoCompletionEmailTemplate":false,"MobileNumber":"String","MobileCountry":"String","ShareUsers":[{"IsDefault":false,"IsOwner":false,"FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"ClientReference":"String","FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"ListItems":[{"ClientField":"String","Item":"String","Value":"String"}],"NoPackage":false,"SingleDocumentAsPackage":false,"NotifyUrl":"String","PackageName":"String","ShareUsers":[{"IsDefault":false,"IsOwner":false,"FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"NoInvitationEmailTemplate":false,"NoCompletionEmailTemplate":false,"Supervising":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"Name":"String","FormDirectReference":"String","Signers":[{"HasSigned":false,"Editable":false,"SignedStatus":"Initialized","DeclinedReason":"String","VideoConfirmationDetail":{"Name":"String","ShortUrl":"String","IsVideoReady":false,"Password":"String","Email":"String","IsWitness":false,"IsVideoDisabled":false,"IsVideoOptOut":false,"WitnessOwner":"String"},"IDCheckStatus":"String","IDVerificationStatus":"String","IDVerificationResult":"String","IDVerificationFaceMatchResult":"String","IDVerificationLivenessResult":"String","SigningKey":"String","SignerReference":"String","IsFaceToFaceSigning":false,"VideoConfirmationEnabled":false,"ReviewBeforeSigningEnabled":false,"MobileNumber":"String","MobileCountry":"String","ShareUsers":[{"IsDefault":false,"IsOwner":false,"FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"ClientReference":"String","FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"Status":"String","DueDate":"String","GMT":"String","LastSignedDate":"String","Folder":"String","Logs":[{"Name":"String","Action":"String","Date":"String","GMT":"String","Role":"String"}],"HasFileUploaded":false,"PackageReference":"String","ClientReference":"String","EditUrl":"String","IDVerificationRequested":false,"MatterNumber":"String","Reference":"String"}]