Secured Signing API

FormFillerFieldRequest

The following routes are available for this service:
GET	/FormFiller/GetFieldTemplate/{TemplateReference}	Gets all field details in a single template	Gets a single template. Returns a collection of fields required for filling the template.

**FormFillerFieldRequest** Parameters:
Name	Parameter	Data Type	Required	Description
TemplateReference	path	string	Yes	Template reference

**FormFillerTemplate** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	Template name
Reference	form	string	Yes	Identifier
Signers	form	array	Yes	List of signers required for the template
Fields	form	array	Yes	List of fields required for the template
ClientReference	form	string	No	client side referese; e.g. external id etc.

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

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

**FormFillerField** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	Yes	Field label
Value	form	string	Yes	Field value
FieldType	form	string	Yes	Field type Allowable Values Text MultiLineText CheckBox RadioButton DropDownList DateInput
IsRequired	form	boolean	Yes	If field is mandatory
ID	form	string	Yes	Field reference; Obsolated, use Reference instead.
Reference	form	string	Yes	Field reference;
ReadOnly	form	boolean	Yes	If field is readonly
ClientField	form	boolean	Yes	Field name on client side

**HTMLElementType** Enum:
Name	Value
Text	0
MultiLineText	1
CheckBox	3
RadioButton	4
DropDownList	5
DateInput	6

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 /FormFiller/GetFieldTemplate/{TemplateReference} HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml

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

<FormFillerTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <ClientReference>String</ClientReference>
  <Fields>
    <FormFillerField>
      <ClientField>String</ClientField>
      <FieldType>Text</FieldType>
      <ID>String</ID>
      <IsRequired>false</IsRequired>
      <Label>String</Label>
      <ReadOnly>false</ReadOnly>
      <Reference>String</Reference>
      <Value>String</Value>
    </FormFillerField>
  </Fields>
  <Name>String</Name>
  <Reference>String</Reference>
  <Signers>
    <Signer>
      <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>
      <VideoConfirmationDeepfakeEnabled>false</VideoConfirmationDeepfakeEnabled>
      <VideoConfirmationEnabled>false</VideoConfirmationEnabled>
    </Signer>
  </Signers>
</FormFillerTemplate>

Secured Signing API

FormFillerFieldRequest

Allowable Values

HTTP + XML