michaelormrod / sample-app-myhr-csharp

MyHR: DocuSign Sample Application

Introduction

MyHR is a DocuSign sample application demonstrating how the DocuSign APIs can be used to construct applications for human resources. MyHR is written in C# using ASP.Net Core 3.1 (server) and Angular 9 (client). You can find a live instance running at https://myhrsample.esigndemos.com/.

MyHR demonstrates the following:

1. Authentication with two different methods

   • Authentication Code Grant
   • JSON Web Token (JWT) Grant

2. User information is shown from the DocuSign account. This example demonstrates Users API endpoint functionality.

3. Direct Deposit update. This example demonstrates filling in bank account information for direct deposit and submitting it to be processed by payroll.

4. W-4 Tax withholding. This example demonstrates filling in a standard W-4 form required by the IRS from all US employees.

5. Time tracking. This example shows how to use the Click API to create a clickwrap programmatically, render it in your UI, and then submit it. It also tracks the submission event and, just after submission, redirects the user back to the start page.

   • More information about the Click API

6. Tuition reimbursement. To prove that a class was completed, users can also attach some written proof before submitting their request for reimbursement. Adding attachments lets users add additional documents for verification.

• More information about adding attachments

7. Send an offer letter to a job candidate. The offer is approved internally first by the user and then sent to a candidate for signing.

8. Send an I-9 verification request to a job candidate using IDV. This example demonstrates sending the Federal I-9 form to a new hire.

   • More information about ID Verification

The examples with templates were created using these DocuSign APIs and features:

• The Docusign Template API functionality.
• The signing ceremony is implemented with embedded signing for a single signer.
• The DocuSign signing ceremony is initiated from your website.
• (AutoPlace anchor text) is used to position the signing fields in the document.

Installation

Prerequisites

• A DocuSign Developer demo account (email and password) on demo.docusign.net. If you don't already have a developer demo account, create a free account.
• A DocuSign integration key (a client ID) that is configured to use JSON Web Token (JWT) Grant authentication. You will need the integration key itself and its RSA key pair. To use this application, you must add your application's Redirect URI to your integration key. This video demonstrates how to create an integration key (client ID) for a user application such as this example.
• C# .NET Core version 3.1 or later
• Node.js v10+

Installation steps

Manual

1. Download or clone this repository to your workstation in a new folder named MyHRSampleApp.
2. The repository includes a Visual Studio 2019 solution file and NuGet package references in the project file.
3. Modify the appsettings.json (the configuration file) with the integration key and other settings from your DocuSign Developer demo account.

   Note: Protect your integration key and client secret. You should make sure that the .env file will not be stored in your source code repository.

4. Navigate to that folder: cd sample-app-myhr-csharp
5. Install client-side dependencies using the npm package manager: npm install

Using installation scripts

Running MyHR

Manual

1. Build and then start the solution.
2. Your default browser will be opened to https://localhost:5001/ and you will see the application's home page.

Using installation scripts

License information

This repository uses the MIT License. See the LICENSE file for more information.