Secured Signing API

SingleFormDirectRequest

The following routes are available for this service:
GET	/FormDirect/GetSingleForm/{FormReference}	Gets a single form	Gets a single form. Returns a collection of signers required for signing the forms.

**SingleFormDirectRequest** Parameters:
Name	Parameter	Data Type	Required	Description
FormReference	path	string	Yes	Form reference

**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
EnableDeepfakeDetector	form	boolean	No	If enable Realify - Deepfake Detector 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

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.

GET /FormDirect/GetSingleForm/{FormReference} HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml

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

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

Secured Signing API

SingleFormDirectRequest

Allowable Values

HTTP + XML