Account

Provide the user session management related functionalities.

APIDescription
POST api/Account/Login

Authenticate user

GET api/Account/UPPRLogin?code={code}

Authenticate user with UPPR code

GET api/Account/SPassLogin?authToken={authToken}

Authenticate user with SPass auth token.

GET api/Account/RegisterSPass?authToken={authToken}

Register SPass with ZorroSign account

POST api/Account/LogOut

Log out user.

POST api/Account/RenewSession

Renew user session.

POST api/Account/ChangePassword

Change password

GET api/Account/RequestAccountActivation

Request to send account activation email

POST api/Account/RegisterUser

Register new ZorroSign user. Include API access key in header with key API_Key_UserRegistration.

GET api/Account/ResetPassword?userName={userName}

Reset user password. Include API access key in header with key API_Key_PasswordReset.

GET api/Account/ValidateCaptcha?encodedResponse={encodedResponse}&type={type}

Validate Google captcha

UserManagement

Provide the user registration and profile management functionalities.

APIDescription
GET api/UserManagement/GetProfile?profileId={profileId}

Get the user profile.

POST api/UserManagement/GetProfilesByIdsAndGroups

Get profiles by list of profile Ids and contact group Ids

POST api/UserManagement/CreateProfile

Create user profile for registered user.

POST api/UserManagement/UpdateProfile

Update user profile.

GET api/UserManagement/GetAllProfiles?organizationId={organizationId}

Get all the active user profiles of organization.

POST api/UserManagement/GetProfileCompleteStatus

Get the user profile completion status.

POST api/UserManagement/UpdateProfileLanguage

Update user profile language.

GET api/UserManagement/ToggleWelcomeVisible?isVisible={isVisible}

Toggle welcome screen visibility.

GET api/UserManagement/ToggleVideoHelpVisible?isVisible={isVisible}

Toggle video help screen visibility.

POST api/UserManagement/UpdateSignaturesByPinCode

Delete current signatures and insert new signatures and initials using pin code.

POST api/UserManagement/UpdateSignatures

Delete current signatures and insert new signatures and initials to profile.

GET api/UserManagement/GetSignaturesByPinCode?pinCode={pinCode}

Get the user signatures by pin code

GET api/UserManagement/GetPinCode

Get new pin code.

POST api/UserManagement/AddProfileImage

Add profile image.

POST api/UserManagement/CreateUser

Create user and profiles for new user.

POST api/UserManagement/RegisterInternalUser

Register internal users for organization

POST api/UserManagement/UpdateUser

Update user account details.

GET api/UserManagement/GetUser?userId={userId}

Create user and profiles for new user.

GET api/UserManagement/GetOrganizationUsers

Gets limited details of users in an organization with admin privileges.

GET api/UserManagement/DeleteUser?userId={userId}

Delete user.

GET api/UserManagement/ActivateUser?userId={userId}

Activate user account.

GET api/UserManagement/DeactivateUser?userId={userId}

Deactivate user account.

GET api/UserManagement/LockUser?userId={userId}

Lock user account.

GET api/UserManagement/UnlockUser?userId={userId}

Unlock user account.

GET api/UserManagement/AgreeToERSD

Update the consent given date for Electronic records and signature disclosure.

GET api/UserManagement/GetUserConsent

No documentation available.

POST api/UserManagement/SendMergeRequest

Sending merge request for the user

POST api/UserManagement/MergeUser

Merge with business user

GET api/UserManagement/GetSupportAccessToken

Get access token to logging in to os ticket

GET api/UserManagement/ValidateSupportAccessToken?accessCode={accessCode}&email={email}

Validate support access token

POST api/UserManagement/CreateSession

Create user session for valid OAuth access token

GET api/UserManagement/GetAuthTicket

Get auth ticket of current logged in user.

GET api/UserManagement/CreateDepartment?departmentName={departmentName}

Create new department for logged in user's organization.

POST api/UserManagement/UpdateDepartment

Update department details

GET api/UserManagement/DeleteDepartment?departmentId={departmentId}

Delete department which is not assigned with users.

GET api/UserManagement/GetAllDepartments

Get all departments of organization.

GET api/UserManagement/GetAllTitles?organizationId={organizationId}

Gets all titles.

POST api/UserManagement/CreateContact

Create contact

POST api/UserManagement/CreateContactList

Create contacts

POST api/UserManagement/ImportContacts

Imports the contacts.

GET api/UserManagement/GetContacts?email={email}&departmentId={departmentId}&userType={userType}

Get user's contacts

GET api/UserManagement/GetContactSummary

Gets contact summary

POST api/UserManagement/UpdateContact

Update user contact

PUT api/UserManagement/UpdateContactList

Update user contactList

GET api/UserManagement/DeleteContact?contactId={contactId}

Delete user contact

POST api/UserManagement/DeleteContacts

Delete collection of user contacts.

POST api/UserManagement/InviteContacts

Invite contacts to ZorroSign

POST api/UserManagement/CreateContactGroup

Create group in address book

POST api/UserManagement/AddGroupContacts

Add users to group

POST api/UserManagement/UpdateContactGroup

Update contact group and its contacts

POST api/UserManagement/GetContactsGroup

Get contacts group

POST api/UserManagement/DeleteContactGroups

Delete contact groups.

POST api/UserManagement/CreateUserGroup

Create user group for organization

POST api/UserManagement/DeleteUserGroup

Delete specific user group

POST api/UserManagement/UpdateUserGroup

Update specific user group information

POST api/UserManagement/UpdateGroup

Update specific user group including users

POST api/UserManagement/AddGroupUsers

POST api/UserManagement/RemoveGroupUsers

Remove users from user group

GET api/UserManagement/GetUserGroup?groupId={groupId}

Get all the user groups withing the organization. Users details assigned to each group will not be populated.

POST api/UserManagement/IsGroupExists

Check whether user group is exists.

POST api/UserManagement/CreateRole

Create new user role with permissions

GET api/UserManagement/GetAllRoles

Get user roles

GET api/UserManagement/DeleteRole?roleId={roleId}

Delete role

POST api/UserManagement/EditRole

Edit role

GET api/UserManagement/GetCountry

Get all countries

POST api/UserManagement/UpgradeToBusinessUser

Upgrades to business user.

GET api/UserManagement/GetUPPRDetail?code={code}

Get UPPR details

POST api/UserManagement/RegisterUPPRProfile

Update UPPR user profile and register the account.

GET api/UserManagement/GenerateBiometricRegistrationQR

Generate QR code for user biometric registration

POST api/UserManagement/AddUserExternalSource

Update organization external spurce details

POST api/UserManagement/UpdateUserExternalSource

Update organization external spurce details

POST api/UserManagement/DeleteUserExternalSource

Delete organization external source

GET api/UserManagement/GetUserExternalSource?externalSourceId={externalSourceId}

Get external source details

GET api/UserManagement/GetProfile/{profileId}

Get the user profile.

Organization

APIDescription
POST api/Organization/AddOrganization

Add organization

POST api/Organization/UpdateOrganization

Update organization details

GET api/Organization/GetOrganization

Get organization details

GET api/Organization/GetOrganizationDetails

Get organization details

POST api/Organization/UpdateOrganizationDetails

Update organization and organization contact details

POST api/Organization/UploadStamp

Upload organization stamp

GET api/Organization/GetStamp

Get Stamp

GET api/Organization/GetLogo

Get organization logo

GET api/Organization/BusinessCategories

Get Business Category

GET api/Organization/GetFontList

Delete organization external source

POST api/Organization/SaveOrganizationFont

Save selected font for the organization

POST api/Organization/AddOrganizationExternalSource

Update organization external spurce details

POST api/Organization/UpdateOrganizationExternalSource

Update organization external spurce details

POST api/Organization/DeleteOrganizationExternalSource

Delete organization external source

GET api/Organization/GetOrganizationExternalSource?externalSourceId={externalSourceId}

Get external source details