Secured Signing API

<back to all web services

SmartTag2Request

The following routes are available for this service:
POST/SmartTag/Send2Send smart tag document. See detailed documentation for Smart Tag.Send a smart tag document.
See detailed documentation for Smart Tag.
SmartTagRequestBase Parameters:
NameParameterData TypeRequiredDescription
QueueReferencemodelstringNoQueue reference
DocumentReferencesmodelarrayYesdocument reference
EmbeddedmodelbooleanNoShows if embedded signing
DueDatemodelstringYesDue date that document are to be signed by.
GMTmodelstringNoGMT Offset
EmailTemplateReferencemodelstringNoInvitation Email template reference; Obsoleted, use InvitationEmailTemplateReference instead.
InvitationEmailTemplateReferencemodelstringNoInvitation Email template reference, if not set, use the user default one.
CompletionEmailTemplateReferencemodelstringNoCompletion Email template reference, if not set, use the user default one.
WorkflowReferencemodelstringNoWorkflow reference
ReturnUrlmodelstringNoReturn Url
SignersmodelarrayNoSigner details, overwrite details populated in document
ListItemsmodelarrayNoThe list options for drop down list field smart tag
NoPackagemodelbooleanNoWhether all documents are in a package (by default) or sent separately
SingleDocumentAsPackagemodelbooleanNoCreate a package even if only one document
NotifyUrlmodelstringNoNotify Url
PackageNamemodelstringNoThe name of the package; if empty and only one document in package, the name will be document name.
ShareUsersmodelarrayNoShare user details, if no share user specified in document
NoInvitationEmailTemplatemodelbooleanNoif true, use Secured Signing default template instead, ignore any template settings
NoCompletionEmailTemplatemodelbooleanNoif true, use Secured Signing default template instead, ignore any template settings
SupervisingformboolNo
SmartTagInvitee Parameters:
NameParameterData TypeRequiredDescription
EmbeddedformbooleanNoShows if embedded signing only for this invitee
ReturnUrlformstringNoReturn Url only for this invitee
EmailTemplateReferenceformstringNoInvitation email template reference only for this invitee; Obsolete, use InvitationEmailTemplateReference instead;
InvitationEmailTemplateReferenceformstringNoInvitation email template reference only for this invitee
CompletionEmailTemplateReferenceformstringNoCompletion email template reference only for this invitee
IsPersonalMessageformboolNoTell if the InvitationText is for personal message or customized email template
InvitationTextformstringNoCustomized email invitation text
EmailSubjectformstringNoCustomized email subject
AttachmentsformList<string>NoThe reference of attachments
NoInvitationEmailTemplateformbooleanNoif true, use Secured Signing default template instead, ignore any template settings
NoCompletionEmailTemplateformbooleanNoif true, use Secured Signing default template instead, ignore any template settings
Invitee Parameters:
NameParameterData TypeRequiredDescription
MobileNumberformstringNoMobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc
MobileCountryformstringNoMobile Country code for phone number e.g. Australia 61, New Zealand 64 etc
ShareUsersformList<ShareUser>No
ClientReferenceformstringNo
UserInfo Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYesFirst name of user
MiddleNameformstringNoMiddle name of user
LastNameformstringYesLast name of user
EmailformstringYesEmail address of user
ShareUser Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformboolNo
IsOwnerformboolNo
DropDownListItem Parameters:
NameParameterData TypeRequiredDescription
ClientFieldformstringYesThe field name on client side
ItemformstringYesItem name
ValueformstringYesItem value
PackageResponse Parameters:
NameParameterData TypeRequiredDescription
QueueReferenceformstringNo
PackageReferenceformstringNo
PackageNameformstringNo
PackageStatusformstringNo
DocumentsformList<DocumentResponse>No
DocumentResponse Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesFile Name
FormDirectReferenceformstringNoForm reference
SignersformarrayYesList of signers
StatusformstringNoDocument signing status

Allowable Values

  • Complete
  • Declined
  • Expired
  • Rejected
  • Signed
  • Filling
  • Filling Form
  • InProgress
  • Signing
  • NotStart
  • # of # Signed
DueDateformstringNoDue Date of document
GMTformstringNoGMT Offset
LastSignedDateformstringNoDate of latest signature
FolderformstringNoThe folder of the document

Allowable Values

  • InBox
  • Progress
  • Signed
LogsformarrayNoDocument logs
HasFileUploadedformbooleanNoWhether invitee uploaded any files during signing process.
PackageReferenceformstringNoPackage reference
ClientReferenceformstringNoclient side referese; e.g. external id etc.
EditUrlformstringNo
IDVerificationRequestedformboolNoID Verification requested.
MatterNumberformstringNoMatter Number
DocumentReferenceResponse Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesDocument reference, used for document access
SignerStatusResponse Parameters:
NameParameterData TypeRequiredDescription
HasSignedformbooleanNoUser signing status
EditableformbooleanNoSigner name and email can be updated by Calling UpdateSigner
SignedStatusformbooleanNoSigner Status

Allowable Values

  • Initialized
  • Invitation
  • Reminder1
  • Reminder2
  • AutoExtend
  • Expired
  • Signed
  • Complete
  • Archived
  • Pending
  • Deleted
  • Rejected
  • Declined
  • Reminder
DeclinedReasonformstringNoDeclined reason. Return only when invitee declined to sign.
VideoConfirmationDetailformVideoConfirmationDetailNo
IDCheckStatusformstringNo
IDVerificationStatusformstringNo
IDVerificationResultformstringNo
IDVerificationFaceMatchResultformstringNo
IDVerificationLivenessResultformstringNo
SignerResponse Parameters:
NameParameterData TypeRequiredDescription
SigningKeyformstringNoUrl for access to signing; Only when this is an embedded signer
Signer Parameters:
NameParameterData TypeRequiredDescription
SignerReferenceformstringNoSigner reference
IsFaceToFaceSigningformboolNo
VideoConfirmationEnabledformboolNo
ReviewBeforeSigningEnabledformboolNo
SignedStatus Enum:
Initialized
Invitation
Reminder1
Reminder2
AutoExtend
Expired
Signed
Complete
Archived
Pending
Deleted
Rejected
Declined
Reminder
VideoConfirmationDetail Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ShortUrlformstringNo
IsVideoReadyformboolNo
PasswordformstringNo
EmailformstringNo
IsWitnessformboolNo
IsVideoDisabledformboolNo
IsVideoOptOutformboolNo
WitnessOwnerformstringNo
DocumentLog Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoName of user responsible for action
ActionformstringNoLog entry
DateformstringNoDate of log entry
GMTformstringNoGMT Offset
RoleformstringNoRole of user responsible for action

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SmartTag/Send2 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

{"QueueReference":"String","PackageReference":"String","PackageName":"String","PackageStatus":"String","Documents":[{"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"}]}