Secured Signing API

SendFormDirectRequest

The following routes are available for this service:
POST	/FormDirect/SendForms2	Starts Form Direct Process	Send a package of forms for filling and signing

**SendFormDirectRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Forms	model	array	Yes	Collection of forms to be sent, if an account reference is not supplied for the forms, the forms will be associated with your api account.
DueDate	model	string	No	Due date that forms are to be signed by. If not set, +14 days is the default
GMT	model	string	No	GMT Offset
InvitationEmailTemplateReference	form	string	No
ListItems	form	List<DropDownListItem>	No

**FormDirect** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	Form name
FormType	form	integer	Yes	Form type
Reference	form	string	Yes	Form reference
Signers	form	object	Yes	List of signers required for the form
EmbedForm	form	boolean	Yes	If true, the signing links will be used in an iFrame to access the forms
ReturnUrl	form	string	No	After signing a form, the page will redirect to the specified url
NotifyUrl	form	string	No	Notify Url
XMLData	form	string	No	Auto fill data for the form. It is an XML document converted to a string. Secured Signing creates the template for the data.
EmployerReference	form	string	No	Auto fill employer data for the form. It can be returned by FormDirect/Employers api. Secured Signing creates the template for the data.
ClientReference	form	string	No	client side referese; e.g. external id etc.

**FormDirectInvitee** Parameters:
Name	Parameter	Data Type	Required	Description
SignerType	form	string	No	Role of invitee in signing process
UseIDData	form	boolean	No	When the use of a mobile phone is required for authencation but is not available, enable this option to use known data about the signer they have to use to ID themselves
IDData	form	AuthInfo	No	Data required for identifying signers with no access to mobile phones
EnabledFaceToFaceSigning	form	boolean	No	If enable face to face signing for this signer or not
Optional	form	boolean	No	When the signer can be optional, tell API this signer is ignored or not.
VideoConfirmation	form	boolean	No	If enable video confirmation for this signer or not

**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

**AuthInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	Yes	Description of the information required
Value	form	string	Yes	Value to be matched by invitee
DataType	form	string	Yes	Data type Allowable Values text date email

**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 /FormDirect/SendForms2 HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendFormDirectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <DueDate>String</DueDate>
  <Forms xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:FormDirect>
      <d2p1:ClientReference>String</d2p1:ClientReference>
      <d2p1:EmbedForm>false</d2p1:EmbedForm>
      <d2p1:EmployerReference>String</d2p1:EmployerReference>
      <d2p1:FormType>0</d2p1:FormType>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NotifyUrl>String</d2p1:NotifyUrl>
      <d2p1:Reference>String</d2p1:Reference>
      <d2p1:ReturnUrl>String</d2p1:ReturnUrl>
      <d2p1:Signers>
        <d2p1:FormDirectInvitee>
          <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:EnabledFaceToFaceSigning>false</d2p1:EnabledFaceToFaceSigning>
          <d2p1:IDData>
            <d2p1:AuthInfo>
              <d2p1:DataType>String</d2p1:DataType>
              <d2p1:Label>String</d2p1:Label>
              <d2p1:Value>String</d2p1:Value>
            </d2p1:AuthInfo>
          </d2p1:IDData>
          <d2p1:Optional>false</d2p1:Optional>
          <d2p1:SignerType>String</d2p1:SignerType>
          <d2p1:UseIDData>false</d2p1:UseIDData>
          <d2p1:VideoConfirmation>false</d2p1:VideoConfirmation>
        </d2p1:FormDirectInvitee>
      </d2p1:Signers>
      <d2p1:XMLData>String</d2p1:XMLData>
    </d2p1:FormDirect>
  </Forms>
  <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>
</SendFormDirectRequest>

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

SendFormDirectRequest

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + XML