Fetch User Details

Retrieve information about the current authorized user. You will receive these user details even if the user has not verified their email address or if the account is not active.

The User Object

Attribute

Type

Description

account_type

integer

The plan the user is currently on.

0: Basic or the free plan
1: Lifetime subscription of Standard
2: Standard plan
3: Plus plan
4: Premium plan

activation_time

time

The time in epoch, when the user verified their email address.

is_auto_renew

integer

If the user is on an auto renewing subscription.

company

string

Company details updated by the user. Name of the company will show up here.

company_size

string

Company details updated by the user.

created_time

time

The time in epoch, when the user created the account.

document_credits

integer

The number of signing credits the user has, if they are on a Basic plan.

email

string

The email address of the user.

first_name

string

First name of the user.

id

integer

User ID of the user.

is_paid

integer

Flag indicating if the user is on a paid plan.

0: Free plan
1: Paid plan

last_name

string

Last name of the user.

last_modified_time

time

The time in epoch, when the user last made changes to their profile information.

referrer_code

string

The referral code of the user.

referrer_promo_left

integer

The number of times, the user's referral code can be redeemed.

subscription_expiry_time

time

The time in epoch, when the user's subscription will expire. If auto renewal is turned on, it would renew at this time.

imported_file_count

integer

The number of times the user imported a document.

signed_file_count

integer

The number of times the user signed a document.

card_brand

string

The card brand, which will be used for subscription renewal.

Only applicable to users who signed up for a subscription on the SignEasy WebApp.

status

integer

Flag indicating if the user has an activated account or not.

0: Not activated
1: Activated account

email_verified

integer

Flag indicating if the user has verified their email address with SignEasy.

0: Not verified. API calls will not function for users with unverified email addresses.
1: Email address verified.

Language
Authentication
OAuth2