| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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.dsx.co.nz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Email":"String","Name":"String","PlanName":"String","DocumentRemain":0,"DocumentUsed":0,"DocumentLeft":0,"DefaultDueDate":0,"MaxDueDate":0,"DateFormat":"String","GMT":"String","Upgrade":"String","MaxUploadSize":0,"Actived":false,"Locked":false,"AccountStatus":"String","UserId":"String","InDefaultPlan":false,"IsAdmin":false,"EnabledFaceToFaceSigning":false,"EnabledVideoConfirmation":false,"EnabledDocNegotiation":false,"EnabledReviewBeforeSigning":false,"NotaryEnabled":false}