Secured Signing API

SmartTag2Request

The following routes are available for this service:
POST	/SmartTag/Send2	Send smart tag document. See detailed documentation for Smart Tag.	Send a smart tag document. See detailed documentation for Smart Tag.

**SmartTagRequestBase** Parameters:
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

**SmartTagInvitee** Parameters:
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

**Invitee** Parameters:
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

**UserInfo** Parameters:
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
Email	form	string	Yes	Email address of user

**ShareUser** Parameters:
Name	Parameter	Data Type	Required	Description
IsDefault	form	bool	No
IsOwner	form	bool	No

**DropDownListItem** Parameters:
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

**PackageResponse** Parameters:
Name	Parameter	Data Type	Required
QueueReference	form	string	No
PackageReference	form	string	No
PackageName	form	string	No
PackageStatus	form	string	No
Documents	form	List<DocumentResponse>	No

**DocumentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	File Name
FormDirectReference	form	string	No	Form reference
Signers	form	array	Yes	List of signers
Status	form	string	No	Document signing status Allowable Values Complete Declined Expired Rejected Signed Filling Filling Form InProgress Signing NotStart # of # Signed
DueDate	form	string	No	Due Date of document
GMT	form	string	No	GMT Offset
LastSignedDate	form	string	No	Date of latest signature
Folder	form	string	No	The folder of the document Allowable Values InBox Progress Signed
Logs	form	array	No	Document logs
HasFileUploaded	form	boolean	No	Whether invitee uploaded any files during signing process.
PackageReference	form	string	No	Package reference
ClientReference	form	string	No	client side referese; e.g. external id etc.
EditUrl	form	string	No
IDVerificationRequested	form	bool	No	ID Verification requested.
MatterNumber	form	string	No	Matter Number

**DocumentReferenceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Reference	form	string	Yes	Document reference, used for document access

**SignerStatusResponse** Parameters:
Name	Parameter	Data Type	Required	Description
HasSigned	form	boolean	No	User signing status
Editable	form	boolean	No	Signer name and email can be updated by Calling UpdateSigner
SignedStatus	form	boolean	No	Signer Status Allowable Values Initialized Invitation Reminder1 Reminder2 AutoExtend Expired Signed Complete Archived Pending Deleted Rejected Declined Reminder
DeclinedReason	form	string	No	Declined reason. Return only when invitee declined to sign.
VideoConfirmationDetail	form	VideoConfirmationDetail	No
IDCheckStatus	form	string	No
IDVerificationStatus	form	string	No
IDVerificationResult	form	string	No
IDVerificationFaceMatchResult	form	string	No
IDVerificationLivenessResult	form	string	No

**SignerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SigningKey	form	string	No	Url for access to signing; Only when this is an embedded signer

**Signer** Parameters:
Name	Parameter	Data Type	Required	Description
SignerReference	form	string	No	Signer reference
IsFaceToFaceSigning	form	bool	No
VideoConfirmationEnabled	form	bool	No
ReviewBeforeSigningEnabled	form	bool	No

**SignedStatus** Enum:
Initialized
Invitation
Reminder1
Reminder2
AutoExtend
Expired
Signed
Complete
Archived
Pending
Deleted
Rejected
Declined
Reminder

**VideoConfirmationDetail** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
ShortUrl	form	string	No
IsVideoReady	form	bool	No
Password	form	string	No
Email	form	string	No
IsWitness	form	bool	No
IsVideoDisabled	form	bool	No
IsVideoOptOut	form	bool	No
WitnessOwner	form	string	No

**DocumentLog** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	Name of user responsible for action
Action	form	string	No	Log entry
Date	form	string	No	Date of log entry
GMT	form	string	No	GMT Offset
Role	form	string	No	Role of user responsible for action

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SmartTag2Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <CompletionEmailTemplateReference>String</CompletionEmailTemplateReference>
  <DocumentReferences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DocumentReferences>
  <DueDate>String</DueDate>
  <EmailTemplateReference>String</EmailTemplateReference>
  <Embedded>false</Embedded>
  <GMT>String</GMT>
  <InvitationEmailTemplateReference>String</InvitationEmailTemplateReference>
  <ListItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:DropDownListItem>
      <d2p1:ClientField>String</d2p1:ClientField>
      <d2p1:Item>String</d2p1:Item>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:DropDownListItem>
  </ListItems>
  <NoCompletionEmailTemplate>false</NoCompletionEmailTemplate>
  <NoInvitationEmailTemplate>false</NoInvitationEmailTemplate>
  <NoPackage>false</NoPackage>
  <NotifyUrl>String</NotifyUrl>
  <PackageName>String</PackageName>
  <QueueReference>String</QueueReference>
  <ReturnUrl>String</ReturnUrl>
  <ShareUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:ShareUser>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MiddleName>String</d2p1:MiddleName>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:IsOwner>false</d2p1:IsOwner>
    </d2p1:ShareUser>
  </ShareUsers>
  <Signers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:SmartTagInvitee>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MiddleName>String</d2p1:MiddleName>
      <d2p1:ClientReference>String</d2p1:ClientReference>
      <d2p1:MobileCountry>String</d2p1:MobileCountry>
      <d2p1:MobileNumber>String</d2p1:MobileNumber>
      <d2p1:ShareUsers>
        <d2p1:ShareUser>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:LastName>String</d2p1:LastName>
          <d2p1:MiddleName>String</d2p1:MiddleName>
          <d2p1:IsDefault>false</d2p1:IsDefault>
          <d2p1:IsOwner>false</d2p1:IsOwner>
        </d2p1:ShareUser>
      </d2p1:ShareUsers>
      <d2p1:Attachments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Attachments>
      <d2p1:CompletionEmailTemplateReference>String</d2p1:CompletionEmailTemplateReference>
      <d2p1:EmailSubject>String</d2p1:EmailSubject>
      <d2p1:EmailTemplateReference>String</d2p1:EmailTemplateReference>
      <d2p1:Embedded>false</d2p1:Embedded>
      <d2p1:InvitationEmailTemplateReference>String</d2p1:InvitationEmailTemplateReference>
      <d2p1:InvitationText>String</d2p1:InvitationText>
      <d2p1:IsPersonalMessage>false</d2p1:IsPersonalMessage>
      <d2p1:NoCompletionEmailTemplate>false</d2p1:NoCompletionEmailTemplate>
      <d2p1:NoInvitationEmailTemplate>false</d2p1:NoInvitationEmailTemplate>
      <d2p1:ReturnUrl>String</d2p1:ReturnUrl>
    </d2p1:SmartTagInvitee>
  </Signers>
  <SingleDocumentAsPackage>false</SingleDocumentAsPackage>
  <Supervising>false</Supervising>
  <WorkflowReference>String</WorkflowReference>
</SmartTag2Request>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PackageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <Documents>
    <DocumentResponse>
      <Reference>String</Reference>
      <ClientReference>String</ClientReference>
      <DueDate>String</DueDate>
      <EditUrl>String</EditUrl>
      <Folder>String</Folder>
      <FormDirectReference>String</FormDirectReference>
      <GMT>String</GMT>
      <HasFileUploaded>false</HasFileUploaded>
      <IDVerificationRequested>false</IDVerificationRequested>
      <LastSignedDate>String</LastSignedDate>
      <Logs>
        <DocumentLog>
          <Action>String</Action>
          <Date>String</Date>
          <GMT>String</GMT>
          <Name>String</Name>
          <Role>String</Role>
        </DocumentLog>
      </Logs>
      <MatterNumber>String</MatterNumber>
      <Name>String</Name>
      <PackageReference>String</PackageReference>
      <Signers>
        <SignerStatusResponse>
          <Email>String</Email>
          <FirstName>String</FirstName>
          <LastName>String</LastName>
          <MiddleName>String</MiddleName>
          <ClientReference>String</ClientReference>
          <MobileCountry>String</MobileCountry>
          <MobileNumber>String</MobileNumber>
          <ShareUsers>
            <ShareUser>
              <Email>String</Email>
              <FirstName>String</FirstName>
              <LastName>String</LastName>
              <MiddleName>String</MiddleName>
              <IsDefault>false</IsDefault>
              <IsOwner>false</IsOwner>
            </ShareUser>
          </ShareUsers>
          <IsFaceToFaceSigning>false</IsFaceToFaceSigning>
          <ReviewBeforeSigningEnabled>false</ReviewBeforeSigningEnabled>
          <SignerReference>String</SignerReference>
          <VideoConfirmationEnabled>false</VideoConfirmationEnabled>
          <SigningKey>String</SigningKey>
          <DeclinedReason>String</DeclinedReason>
          <Editable>false</Editable>
          <HasSigned>false</HasSigned>
          <IDCheckStatus>String</IDCheckStatus>
          <IDVerificationFaceMatchResult>String</IDVerificationFaceMatchResult>
          <IDVerificationLivenessResult>String</IDVerificationLivenessResult>
          <IDVerificationResult>String</IDVerificationResult>
          <IDVerificationStatus>String</IDVerificationStatus>
          <SignedStatus>Initialized</SignedStatus>
          <VideoConfirmationDetail>
            <Email>String</Email>
            <IsVideoDisabled>false</IsVideoDisabled>
            <IsVideoOptOut>false</IsVideoOptOut>
            <IsVideoReady>false</IsVideoReady>
            <IsWitness>false</IsWitness>
            <Name>String</Name>
            <Password>String</Password>
            <ShortUrl>String</ShortUrl>
            <WitnessOwner>String</WitnessOwner>
          </VideoConfirmationDetail>
        </SignerStatusResponse>
      </Signers>
      <Status>String</Status>
    </DocumentResponse>
  </Documents>
  <PackageName>String</PackageName>
  <PackageReference>String</PackageReference>
  <PackageStatus>String</PackageStatus>
  <QueueReference>String</QueueReference>
</PackageResponse>

Secured Signing API

SmartTag2Request

Allowable Values

Allowable Values

Allowable Values

HTTP + XML