Secured Signing API

<back to all web services

FormDirectRequest

The following routes are available for this service:
GET/FormDirect/GetFormListGets form listGets a list of Forms available for an account. Returns a collection of signers required for signing the forms.

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/GetFormList HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml

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

<ArrayOfFormDirect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <FormDirect>
    <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>
</ArrayOfFormDirect>