Secured Signing API

<back to all web services

AccountRequest

Account
The following routes are available for this service:
GET/Account/InfoGet account informationGet account information.
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNoThe email of the account user
NameformstringNoThe name of the account user
PlanNameformstringNoThe price plan name of the account
DocumentRemainformstringNoThe amount of documents remain in the plan, not applied to PAYG and Global Membership
DocumentUsedformstringNoThe amount of documents used
DocumentLeftformstringNoThe amount of documents available; use this to determine if new document can be uploaded.
DefaultDueDateformstringNoDefault due date setting in days of this account
MaxDueDateformstringNoMaximum due date setting in days of this account; note that it's in weeks in Secured Signing Web UI.
DateFormatformstringNoThe signature date format setting of the account; Not for date in API response;
GMTformstringNoDefault GMT of the user
UpgradeformstringNoThe upgrade key of the account; keep it to ask user to pay to upgrade the price plan
MaxUploadSizeformstringNoThe maximum size cab be uploaded for each document
ActivedformstringNoIf the account is actived or not
LockedformstringNoIf the account is locked or not
AccountStatusformstringNoThe status of the account

Allowable Values

  • FreeWay
  • Paid
  • OnHold
  • Inactive
  • Cancelled
  • Expired
  • Disabled
UserIdformstringNoThe reference of the user
InDefaultPlanformstringNoFor internal use only
IsAdminformstringNoFor internal use only
EnabledFaceToFaceSigningformstringNoIf the account enables Face to Face signing
EnabledVideoConfirmationformstringNoIf the account enables Video Confirmation before signing
EnabledDocNegotiationformstringNoIf the account enables document negotiation
EnabledReviewBeforeSigningformstringNoIf the account enables review before signing
NotaryEnabledformstringNoIf the user is setup notary or not

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 /Account/Info HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccountInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <AccountStatus>String</AccountStatus>
  <Actived>false</Actived>
  <DateFormat>String</DateFormat>
  <DefaultDueDate>0</DefaultDueDate>
  <DocumentLeft>0</DocumentLeft>
  <DocumentRemain>0</DocumentRemain>
  <DocumentUsed>0</DocumentUsed>
  <Email>String</Email>
  <EnabledDocNegotiation>false</EnabledDocNegotiation>
  <EnabledFaceToFaceSigning>false</EnabledFaceToFaceSigning>
  <EnabledReviewBeforeSigning>false</EnabledReviewBeforeSigning>
  <EnabledVideoConfirmation>false</EnabledVideoConfirmation>
  <GMT>String</GMT>
  <InDefaultPlan>false</InDefaultPlan>
  <IsAdmin>false</IsAdmin>
  <Locked>false</Locked>
  <MaxDueDate>0</MaxDueDate>
  <MaxUploadSize>0</MaxUploadSize>
  <Name>String</Name>
  <NotaryEnabled>false</NotaryEnabled>
  <PlanName>String</PlanName>
  <Upgrade>String</Upgrade>
  <UserId>String</UserId>
</AccountInfo>