GET | /Account/Info | Get account information | Get account information. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
form | string | No | The email of the account user | |
Name | form | string | No | The name of the account user |
PlanName | form | string | No | The price plan name of the account |
DocumentRemain | form | string | No | The amount of documents remain in the plan, not applied to PAYG and Global Membership |
DocumentUsed | form | string | No | The amount of documents used |
DocumentLeft | form | string | No | The amount of documents available; use this to determine if new document can be uploaded. |
DefaultDueDate | form | string | No | Default due date setting in days of this account |
MaxDueDate | form | string | No | Maximum due date setting in days of this account; note that it's in weeks in Secured Signing Web UI. |
DateFormat | form | string | No | The signature date format setting of the account; Not for date in API response; |
GMT | form | string | No | Default GMT of the user |
Upgrade | form | string | No | The upgrade key of the account; keep it to ask user to pay to upgrade the price plan |
MaxUploadSize | form | string | No | The maximum size cab be uploaded for each document |
Actived | form | string | No | If the account is actived or not |
Locked | form | string | No | If the account is locked or not |
AccountStatus | form | string | No | The status of the accountAllowable Values
|
UserId | form | string | No | The reference of the user |
InDefaultPlan | form | string | No | For internal use only |
IsAdmin | form | string | No | For internal use only |
EnabledFaceToFaceSigning | form | string | No | If the account enables Face to Face signing |
EnabledVideoConfirmation | form | string | No | If the account enables Video Confirmation before signing |
EnabledDocNegotiation | form | string | No | If the account enables document negotiation |
EnabledReviewBeforeSigning | form | string | No | If the account enables review before signing |
NotaryEnabled | form | string | No | If 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
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>