Account Details (GET /v2.0/account)
This method returns details about the account.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message |
Response Body Data Fields
| Field | Always Present? | Value |
|---|---|---|
| subscription | Yes | Subscription details JSON object |
| subscription.plan_name | Yes | Subscription name |
| subscription.start_date | Yes | Subscription start date |
| subscription.end_date | Yes | Subscription end date |
| subscription.renewal_date | Yes | Subscription renewal date |
| subscription.remaining_days | Yes | Subscription expiration remaining days |
| subscription.currency_code | Yes | Currency code |
| subscription.account_id | Yes | Account ID |
| subscription.account_created_date | Yes | Account created date |
| plan | Yes | Plan details JSON object |
| plan.document_limit | Yes | Document creation limit |
| plan.template_limit | Yes | Template creation limit |
| plan.number_of_docs_per_envelope | Yes | Number of documents allowed per envelope |
| plan.user_limit | Yes | User limit under one account |
| plan.supported_file_size | Yes | Max supported file size |
| plan.supported_sign_types | Yes | Allowed signed type |
| plan.supported_file_types | Yes | Supported file type |
| plan.supported_features | Yes | Supported features |
| user | Yes | User details JSON object |
| user.first_name | Yes | User first name |
| user.last_name | Yes | User last name |
| user.email | Yes | User email address |
| user.status | Yes | User status (active/inactive) |
| user.is_admin | Yes | Returns true if user is admin |
| alerts | Yes | Alerts details JSON object |
| alerts.is_locked | Yes | Returns true if the account is locked |
| alerts.cancellation_requested | Yes | Returns true if cancellation is requested |
| alerts.document_exhausted | Yes | Returns true if document limit is passed |
| alerts.template_exhausted | Yes | Returns true if template limit is passed |
| alerts.user_exhausted | Yes | Returns true if user limit is passed. |
| quota | Yes | Quota details JSON object. |
| quota.templates_left | Yes | Number of templates remaining |
| quota.documents_left | Yes | Number of documents remaining |
| quota.users_left | Yes | Number of users remaining |
Sample Success Response
REQUEST:
curl --location --request GET 'api/v2.0/account' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9'
RESPONSE:
{
"message": "",
"data": {
"subscription": {
"plan_name": "jSign Plus",
"start_date": "12/02/2021",
"end_date": "01/02/2022",
"renewal_date": "01/02/2022",
"remaining_days": "21",
"currency_code": "USD",
"account_id": "51e95f35-b0fb-472c-be5f-2546ded565a1",
"account_created_date": "01/04/2021"
},
"plan": {"document_limit": 10,
"template_limit": 10,
"number_of_docs_per_envelope" : 10,
"user_limit": 10,
"supported_file_size": "25 MB",
"supported_sign_types": "Esignature",
"supported_file_types": "PDF, DOCX",
"supported_features": "Google Drive, Drop Box, One Drive"},
"user": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"status": "active",
"is_admin": false
},
"alerts": {
"is_locked": "false",
"cancellation_requested": "false",
"document_exhausted": "false",
"template_exhausted": "false",
"user_exhausted": "NA"
},
"quota": {
"templates_left": "5",
"documents_left": "5",
"users_left": "NA"
}
}
}
Sample Error Response
REQUEST:
curl --location --request GET 'api/v2.0/account' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9'
RESPONSE:
{
"errors": [
{
"error_code": "ACCOUNT_DATA_PROCESSING_FAILURE",
developer_message": "An error occurred during account data processing. Please try after some time."
}
]
}
Note: View the full list of applicable error code for this method here.