Users

user object in signNow allows you to track the invites, documents and templates associated with one user. Using API you can create, update and delete users, retrieve their info, verify their emails, reset passwords, track changes with user’s documents, templates, document groups, folders and teams, add them to or remove from organizations. The user object is also crucial to event subscriptions: signNow enables you to trigger callbacks by an event of a specific user.

The user object

Attributes
  • id string
    Unique identifier for the object.
  • first_name string
    User's first name
  • last_name string
    User's last name
  • active string
    When the user is active in signNow, this attribute shows "1", otherwise "0".
  • created string
    Unix timestamp for when the user was created
More attributes
  • type integer
  • pro integer
  • emails array[string]
  • primary_email string
  • subscriptions array[object]
  • credits integer
  • has_atticus_access boolean
  • cloud_export_account_details null
  • is_logged_in boolean
  • billing_period object
  • premium_access object
  • companies array[object]
  • document_count integer
  • monthly_document_count string
  • teams array[object]
  • lifetime_document_count integer
  • googleapps boolean
  • facebookapps boolean
  • status object
  • settings object
  • organization_settings array[object]
  • issue_notifications array[object]
  • merchant_accounts array[object]
  • organization object
  • registation_source null
The user object
{
  "id": "9c4bd7cfafbe481da5556416480774d2f6eb9ex0",
  "first_name": "First name",
  "last_name": "Last name",
  "active": "1",
  
  "verified": true,
  "type": 1,
  "pro": 0,
  
  "created": "1532078494",
  "emails": [],
  "primary_email": "email@email.com",
  "subscriptions": [],
  "credits": 0,
  "has_atticus_access": false,
  "cloud_export_account_details": null,
  "is_logged_in": true,
  "billing_period": {
    "start_date": "xx/xx/xxxx",
    "end_date": "xx/xx/xxxx",
    "start_timestamp": 1532044800,
    "end_timestamp": 1534723200
  },
  "companies": [],
  "document_count": 0,
  "monthly_document_count": "15",
  "registration_source": , //can be: null, "pdffiller", "airslate"
  "teams": [],
  "lifetime_document_count": 16,
  "googleapps": false,
  "status": {},
  "settings": {},
  "organization_settings": [],
  "issue_notifications": [],
  "merchant_accounts": [],
}
            

Create user

Creates a new user in signNow.

Parameters
  • email required
    User's email address.
  • password required
    User's password, 6 characters minimum.
  • first_name optional
    User's first name.
  • last_name optional
    User's last name.
  • number optional
    User's phone number.
More parameters
  • source optional
  • skip_30day_trial optional
  • signing_link optional
  • tos_accept optional
Returns

Returns the new user ID. Returns an error when:

  • “unverified_email” - email has been registered on site before, but not verified
  • “internal api error” - request without a required field in body
  • “user with email exists” - email has been registered and verified on site before
  • “invalid payload” - request without body
POST /user
curl -X POST \
  https://api-eval.signnow.com/oauth2/token \
  -H 'Authorization: Basic {{basic_authorization_token}}' \
  -H 'Content-Type: multipart/form-data;' \
  -F 'username={{user_email}}' \
  -F 'password={{user_password}}' \
  -F 'grant_type=password' \
  -F 'scope=*' 
              
Response
{
  "id": "aad13814e8f369089ee2f12b533545f9534e6cf8",
  "verified": 0,
  "email": "user@signnow.com"
}
              

Get user

Returns a user object.

No body parameters required
Returns

Returns an error when the request is sent with an incorrect token (must be a Bearer-type token).

GET /user
curl -X GET \
  https://api-eval.signnow.com/user \
  -H 'Authorization: Bearer {{token}}' \
  -H 'Content-Type: application/json' \
              
Response

{
  "id": "9c4bd7cfafbe481da5556416480774d2f6eb9ex0",
  "first_name": "First name",
  "last_name": "Last name",
  "active": "1",

  "verified": true,
  "type": 1,
  "pro": 0,

  "created": "1532078494",
  "emails": [],
  "primary_email": "email@email.com",
  "subscriptions": [],
  "credits": 0,
  "has_atticus_access": false,
  "cloud_export_account_details": null,
  "is_logged_in": true,
  "billing_period": {
    "start_date": "xx/xx/xxxx",
    "end_date": "xx/xx/xxxx",
    "start_timestamp": 1532044800,
    "end_timestamp": 1534723200
  },
  "companies": [],
  "document_count": 0,
  "monthly_document_count": "15",
  "registration_source": , //can be: null, "pdffiller", "airslate"
  "teams": [],
  "lifetime_document_count": 16,
  "googleapps": false,
  "status": {},
  "settings": {},
  "organization_settings": [],
  "issue_notifications": [],
  "merchant_accounts": [],
}
              

Change user details

Updates user information i.e. first name, last name.

Parameters
  • first_name optional
    Add this parameter only to specify a new first name for the user.
  • last_name optional
    Add this parameter only to specify a new last name for the user.
  • password optional
    Add this parameter if a user would like to change their password. Its value is the new password.
  • old_password optional
    If a “password” parameter has been added to the body, then this one is required.
  • logout_all optional
    If “true” - all user tokens with “scope=*” expire.
    If “false” - all user tokens except current one expire.
    Note: parameter must have string format.
    Default value: “true”
Returns

Returns the user ID with successfully updated parameters. Returns an error when:

  • First_name is too long (more than 64 characters)
  • Last_name is too long (more than 64 characters). It cuts down to 64 characters.
  • Old_password is empty or incorrect
  • New_password is empty
PUT /user
curl --X PUT \
https://api-eval.signnow.com/user \
  -H 'Authorization: Bearer {{token}}' \
  -H 'Content-Type: application/json' \
  -d '{                  
    "first_name": "{{updated_name}}",
    "last_name": "{{updated_last_name}}",
    "password": "{{updated_password}}",                  
    "old_password": "{{old_password}}",
    "logout_all": "true"
  }'  
              
Response
{
  "id": "unique_id",
  "first_name": "new_first_name",
   "last_name": "new_last_name"
}
              

Send verification email

Sends verification email to a user.

Parameters
  • email required
    Unverified email address.
  • Returns

    Returns “success” when the verification email is sent. Returns an error when:

    • “Could not send verification email” - request with not existing email address
    • “User email is already verified” - request with already verified email address
POST /user/verifyemail
curl  -X POST \
  https://api-eval.signnow.com/user/verifyemail \
  -H 'Authorization: Basic {{basic}}' \
  -H 'Content-Type: application/json' \
-d '{                  
    "email": "user@email.com"
}'
              
Response
                    {
                  
                      "status": "success"
                  
                    }
                  

Verify email

Verifies user's email address using code from verification email.

Parameters
  • email required
    User's email address.
  • verification_token required
    The token that verifies the email address from the verification email (sent by the POST /user/verifyemail request).
Returns

Returns a verified email address in a response. Returns an error when the verification token expires or does not match the email address.

PUT /user/email/verify
curl -X PUT \
  https://api-eval.signnow.com/user/email/verify \
  -H 'Authorization: Basic {{basic_authorization_token}}' \
  -H 'content-type: application/json' \
-d '{                
  "email": "email@domain.com",                 
  "verification_token":"token"                  
}'
            
Response
{
  "email":"email@domain.com"
}
            

Reset password

Sends password reset link via email.

Parameters
  • email required
    User’s email address that receives the password reset link.
Returns

Confirms a successful status when the email is sent. Returns an error if the email address was missing or incorrect.

POST /user/forgotpassword
curl -X POST \
  https://api-eval.signnow.com/user/forgotpassword \
  -H 'Authorization: Basic {{basic}}' Basic {{basic_authorization_token}}' \
  -H 'Content-Type: application/json' application/json' \
  -d '{
    "email":  "email@domain.com"
}'
              
Response
{
  "status":"success"
}
              

Get modified documents

Returns an array of user's documents that have been modified (added fields, texts, signatures, etc.)

Query parameters
  • ?per_page optional
    How many document objects to display per page in response. By default, it’s 15, maximum 100.
  • Returns

    Returns an error if cannot fetch documents.

GET /user/documentsv2
curl -X GET \
  https://api-eval.signnow.com/user/documentsv2 \
  -H 'Authorization: Bearer {{token}}' \
  -H 'Content-Type: application/json' application/json' \
              
Response
[
  {
    "id": "document_unique_id",
    "user_id": "user_unique_id",
    "document_name": "Document name",
"page_count": "2",
    "created": "timestamp",
    "updated": "timestamp",
    "original_filename": "Original Document name",
    "owner": "email@domain.com",
    "version_time": "timestamp",
    "template": false|true,
    "origin_document_id": null,
    "origin_user_id": null,
    "thumbnail":
     {
        "small": "http://api.vm.signnow.com/document/document_unique_id/thumbnail?size=small",
        "medium":
"http://api.vm.signnow.com/document/document_unique_id/thumbnail?size=medium",
        "large": "http://api.vm.signnow.com/document/document_unique_id/thumbnail?size=large"
      },
    "signatures": [],
    "seals": [],
    "texts": [],
    "checks": [],
    "inserts": [],
    "tags": [],
    "fields": [],
    "requests": [],
    "notary_invites": [],
    "field_invites": [],
    "enumeration_options": [],
    "attachments": [],
    "routing_details": [],
    "roles": [],
    "radiobuttons": [],
    "integrations": [],
    "document_group_info": {
    "document_group_id": null,
    "document_group_name": null,
    "invite_id": null,
    "invite_status": null,
    "doc_count_in_group": 0
  },
  "settings": {
  "no_document_attachment": false,
  "copy_export": false,
  "no_document_file_attachments": false,
  "no_user_signature_return": false,
  "mobileweb_option": false,
  "require_drawn_signatures": false,
  "org_allowed_team_admins": false,
  "cloud_auto_export": false,
  "digitally_sign_dowloaded_docs": false,
  "invite_completion_redirect_url": false,
  "invite_decline_redirect_url": false,
  "add_signature_stamp": false,
  "pending_invite_document_view_notification": false,
  "flatten_document_fields": false,
  "required_preset_signature_name": false,
  "signing_link_document_download": false,
  "attach_doc_on_all_cc_messages": false,
  "document_completion_retention_days": false,
  "cloud_export_with_history": false,
  "emailed_docs_include_history": false,
  "require_email_subject": false,
  "enable_hyperlink_protection": false,
  "enable_advanced_threat_protection": false,
  "require_login_for_signing": false,
  "logout_on_signing": false,
  "audit_trail_completion_retention_days": false,
  "front_end_session_length": false,
  "email_admin_on_banned_login": false,
  "add_signature_stamp_with_name": false,
  "cfr_title_21_part_11": false,
  "unsuccessful_logout_attempts_allowed": false,
  "require_authentication_for_invites": false,
  "electronic_consent_required": false,
  "electronic_consent_text": false
  },
"originator_organization_settings": [
  {
    "setting": "invite_completion_redirect_url",
    "value": ""
  },
  {
    "setting": "invite_decline_redirect_url",
    "value": ""
  },
  {
    "setting": "required_preset_signature_name",
    "value": "0"
  },
  {
    "setting": "require_email_subject",
    "value": "0"
  },
  {
    "setting": "require_login_for_signing",
    "value": "0"
  },
  {
    "setting": "logout_on_signing",
    "value": "0"
  },
  {
    "setting": "front_end_session_length",
    "value": "0"
  },
  {
    "setting": "add_signature_stamp_with_name",
    "value": "0"
  },
  {
        "setting": "cfr_title_21_part_11",
        "value": "0"
  },
  {
    "setting": "require_authentication_for_invites",
    "value": "0"
  }
],
"document_group_template_info": []
}
]
              

Get user documents

Returns an array of user's documents that have not been modified yet.

Query parameters
  • ?per_page optional
    How many document objects to display per page in response. By default, it’s 15, maximum 100.
  • Returns

    Returns an error if cannot fetch documents.

GET /user/documents
curl -X GET \
  https://api-eval.signnow.com/user/documents \
  -H 'Authorization: Bearer {{token}}' \
  -H 'Content-Type: application/json' application/json' \
              
Response
[
  {
    "id": "document_unique_id",
    "user_id": "user_unique_id",
    "document_name": "Document name",
    "page_count": "2",
    "created": "timestamp",
    "updated": "timestamp",
    "original_filename": "Original Document name",
    "owner": "email@domain.com",
    "version_time": "timestamp",
    "template": false|true,
    "origin_document_id": null,
    "origin_user_id": null,
    "thumbnail":
     {
        "small": "http://api.vm.signnow.com/document/document_unique_id/thumbnail?size=small",
        "medium":
"http://api.vm.signnow.com/document/document_unique_id/thumbnail?size=medium",
        "large": "http://api.vm.signnow.com/document/document_unique_id/thumbnail?size=large"
      },
    "signatures": [],
    "seals": [],
    "texts": [],
    "checks": [],
    "inserts": [],
    "tags": [],
    "fields": [],
    "requests": [],
    "notary_invites": [],
    "field_invites": [],
    "enumeration_options": [],
    "attachments": [],
    "routing_details": [],
    "roles": [],
    "radiobuttons": [],
    "integrations": [],
    "document_group_info": {
    "document_group_id": null,
    "document_group_name": null,
    "invite_id": null,
    "invite_status": null,
    "doc_count_in_group": 0
  },
  "settings": {
  "no_document_attachment": false,
  "copy_export": false,
  "no_document_file_attachments": false,
  "no_user_signature_return": false,
  "mobileweb_option": false,
  "require_drawn_signatures": false,
  "org_allowed_team_admins": false,
  "cloud_auto_export": false,
  "digitally_sign_dowloaded_docs": false,
  "invite_completion_redirect_url": false,
  "invite_decline_redirect_url": false,
  "add_signature_stamp": false,
  "pending_invite_document_view_notification": false,
  "flatten_document_fields": false,
  "required_preset_signature_name": false,
  "signing_link_document_download": false,
  "attach_doc_on_all_cc_messages": false,
  "document_completion_retention_days": false,
  "cloud_export_with_history": false,
  "emailed_docs_include_history": false,
  "require_email_subject": false,
  "enable_hyperlink_protection": false,
  "enable_advanced_threat_protection": false,
  "require_login_for_signing": false,
  "logout_on_signing": false,
  "audit_trail_completion_retention_days": false,
  "front_end_session_length": false,
  "email_admin_on_banned_login": false,
  "add_signature_stamp_with_name": false,
  "cfr_title_21_part_11": false,
  "unsuccessful_logout_attempts_allowed": false,
  "require_authentication_for_invites": false,
  "electronic_consent_required": false,
  "electronic_consent_text": false
  },
"originator_organization_settings": [
  {
    "setting": "invite_completion_redirect_url",
    "value": ""
  },
  {
    "setting": "invite_decline_redirect_url",
    "value": ""
  },
  {
    "setting": "required_preset_signature_name",
    "value": "0"
  },
  {
    "setting": "require_email_subject",
    "value": "0"
  },
  {
    "setting": "require_login_for_signing",
    "value": "0"
  },
  {
    "setting": "logout_on_signing",
    "value": "0"
  },
  {
    "setting": "front_end_session_length",
    "value": "0"
  },
  {
    "setting": "add_signature_stamp_with_name",
    "value": "0"
  },
  {
        "setting": "cfr_title_21_part_11",
        "value": "0"
  },
  {
    "setting": "require_authentication_for_invites",
    "value": "0"
  }
],
"document_group_template_info": []
  }
]