Updating to Rest V2.1 + IDV

Author: MattKingDS

README.md

@@ -5,49 +5,66 @@
 This repo includes bash scripts that use curl to demonstrate:
 
 1. **Embedded Signing Ceremony.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg001EmbeddedSigning.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg001EmbeddedSigning.sh)
    This example sends an envelope, and then uses an embedded signing ceremony for the first signer.
    With embedded signing, the DocuSign signing ceremony is initiated from your website.
 1. **Send an envelope with a remote (email) signer and cc recipient.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg002SigningViaEmail.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg002SigningViaEmail.sh)
    The envelope includes a pdf, Word, and HTML document.
    Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents.
 1. **List envelopes in the user's account.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg003ListEnvelopes.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg003ListEnvelopes.sh)
 1. **Get an envelope's basic information.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg004EnvelopeInfo.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg004EnvelopeInfo.sh)
    The example lists the basic information about an envelope, including its overall status.
 1. **List an envelope's recipients** 
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg005EnvelopeRecipients.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg005EnvelopeRecipients.sh)
    Includes current recipient status.
 1. **List an envelope's documents.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg006EnvelopeDocs.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg006EnvelopeDocs.sh)
 1. **Download an envelope's documents.** 
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg007EnvelopeGetDoc.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg007EnvelopeGetDoc.sh)
    The example can download individual
    documents, the documents concatenated together, or a zip file of the documents.
 1. **Programmatically create a template.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg008CreateTemplate.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg008CreateTemplate.sh)
 1. **Send an envelope using a template.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg009UseTemplate.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg009UseTemplate.sh)
 1. **Send an envelope and upload its documents with multipart binary transfer.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg010SendBinaryDocs.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg010SendBinaryDocs.sh)
    Binary transfer is 33% more efficient than using Base64 encoding.
 1. **Embedded sending.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg011EmbeddedSending.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg011EmbeddedSending.sh)
    Embeds the DocuSign web tool (NDSE) in your web app to finalize or update 
    the envelope and documents before they are sent.
 1. **Embedded DocuSign web tool (NDSE).**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg012EmbeddedConsole.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg012EmbeddedConsole.sh)
 1. **Embedded Signing Ceremony from a template with an added document.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg013AddDocToTemplate.sh)
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg013AddDocToTemplate.sh)
    This example sends an envelope based on a template.
    In addition to the template's document(s), the example adds an
    additional document to the envelope by using the
    [Composite Templates](https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates)
    feature.
-1. **Payments example: an order form, with online payment by credit card.**
-   [Source.](https://github.com/docusign/eg-03-curl/blob/master/examples/eg014CollectPayment.sh)
+1. **Get the envelope tab data.** (Coming Soon...)
+1. **Set envelope tab values.** (Coming Soon...)
+1. **Set template tab values.** (Coming Soon...)
+1. **Get the envelope custom field data (metadata).** (Coming Soon...)
+1. **Send an envelope with a remote (email) signer using Access Code authentication.**
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg019SigningViaEmailWithAccessCode.sh)
+   This example sends an envelope using remote (email) signing requiring the recipient to enter an access code.
+1. **Send an envelope with a remote (email) signer using SMS authentication.**
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg020SigningViaEmailWithSmsAuthentication.sh)
+   This example sends an envelope using remote (email) signing requiring the recipient to supply a verification code sent to them via SMS.
+1. **Send an envelope with a remote (email) signer using Phone authentication.**
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg021SigningViaEmailWithPhoneAuthentication.sh)
+   This example sends an envelope using remote (email) signing requiring the recipient to supply a verification code sent to them via a phone call.
+1. **Send an envelope with a remote (email) signer using Knowledge-Based authentication.**
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg022SigningViaEmailWithKnoweldgeBasedAuthentication.sh)
+   This example sends an envelope using remote (email) signing requiring the recipient to validate their identity via Knowledge-Based authentication.
+1. **Send an envelope with a remote (email) signer using Identity Verification.**
+   [Source.](https://github.com/docusign/eg-03-curl/blob/apiv2/examples/eg023SigningViaEmailWithIDVAuthentication.sh)
+   This example sends an envelope using remote (email) signing requiring the recipient to validate their identity via a government issued ID.
 
 ## Installation
 
@@ -76,7 +93,7 @@ file:
 ### Payments code example
 To use the payments code example, first create a test payments gatway in your account.
 Follow the instructions in the
-[PAYMENTS_INSTALLATION.md](https://github.com/docusign/eg-03-curl/blob/master/PAYMENTS_INSTALLATION.md)
+[PAYMENTS_INSTALLATION.md](https://github.com/docusign/eg-03-curl/blob/apiv2/PAYMENTS_INSTALLATION.md)
 file.
 
 Then add the payment gateway id to the code example file.
@@ -107,6 +124,16 @@ bash eg010SendBinaryDocs.sh
 bash eg011EmbeddedSending.sh
 bash eg012EmbeddedConsole.sh
 bash eg013AddDocToTemplate.sh
+base eg014Payments.sh (Coming Soon...)
+bash eg015GetEnvelopeTabData.sh (Coming Soon...)
+bash eg016SetEnvelopeTabValues.sh (Coming Soon...)
+bash eg017SetTemplateTabValues.sh (Coming Soon...)
+bash eg018GetEnvelopeCustomFieldData.sh (Coming Soon...)
+bash eg019SigningViaEmailWithAccessCode.sh
+bash eg020SigningViaEmailWithSmsAuthentication.sh
+bash eg021SigningViaEmailWithPhoneAuthentication.sh
+bash eg022SigningViaEmailWithKnoweldgeBasedAuthentication.sh
+bash eg023SigningViaEmailWithIDVAuthentication.sh
 
 # Note: to use example 14 you must also configure a
 # payment gateway for your account.

examples/eg001EmbeddedSigning.sh

@@ -87,7 +87,7 @@ printf \
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
      --data-binary @${request_data} \
-     --request POST ${base_path}/v2/accounts/${account_id}/envelopes \
+     --request POST ${base_path}/v2.1/accounts/${account_id}/envelopes \
      --output ${response}
 
 echo ""
@@ -119,7 +119,7 @@ curl --header "Authorization: Bearer ${access_token}" \
     "userName": "{USER_FULLNAME}",
     "clientUserId": 1000,
 }' \
-     --request POST ${base_path}/v2/accounts/${account_id}/envelopes/${envelope_id}/views/recipient \
+     --request POST ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}/views/recipient \
      --output ${response}
 
 echo ""

examples/eg002SigningViaEmail.sh

@@ -116,7 +116,7 @@ printf \
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
      --data-binary @${request_data} \
-     --request POST ${base_path}/v2/accounts/${account_id}/envelopes \
+     --request POST ${base_path}/v2.1/accounts/${account_id}/envelopes \
      --output $response
 
 echo ""

examples/eg003ListEnvelopes.sh

@@ -38,7 +38,7 @@ curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
      --get \
      --data-urlencode "from_date=${from_date}" \
-     --request GET ${base_path}/v2/accounts/${account_id}/envelopes
+     --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes
 # ***DS.snippet.0.end
 
 echo ""

examples/eg004EnvelopeInfo.sh

@@ -35,7 +35,7 @@ echo ""
 # ***DS.snippet.0.start
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
-     --request GET ${base_path}/v2/accounts/${account_id}/envelopes/${envelope_id}
+     --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}
 # ***DS.snippet.0.end
 
 echo ""

examples/eg005EnvelopeRecipients.sh

@@ -35,7 +35,7 @@ echo ""
 # ***DS.snippet.0.start
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
-     --request GET ${base_path}/v2/accounts/${account_id}/envelopes/${envelope_id}/recipients
+     --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}/recipients
 # ***DS.snippet.0.end
 
 echo ""

examples/eg006EnvelopeDocs.sh

@@ -35,7 +35,7 @@ echo ""
 # ***DS.snippet.0.start
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
-     --request GET ${base_path}/v2/accounts/${account_id}/envelopes/${envelope_id}/documents
+     --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}/documents
 # ***DS.snippet.0.end
 
 echo ""

examples/eg007EnvelopeGetDoc.sh

@@ -72,7 +72,7 @@ echo ""
 # ***DS.snippet.0.start
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
-     --request GET ${base_path}/v2/accounts/${account_id}/envelopes/${envelope_id}/documents/${doc_choice} \
+     --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}/documents/${doc_choice} \
      --output ${output_file}${output_file_extension}
 # ***DS.snippet.0.end
 

examples/eg008CreateTemplate.sh

@@ -28,7 +28,7 @@ curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
      --get \
      --data-urlencode "search_text=${template_name}" \
-     --request GET ${base_path}/v2/accounts/${account_id}/templates \
+     --request GET ${base_path}/v2.1/accounts/${account_id}/templates \
      --output $response
 
 # pull out the templateId if it was returned
@@ -184,7 +184,7 @@ printf \
 curl --header "Authorization: Bearer ${access_token}" \
      --header "Content-Type: application/json" \
      --data-binary @${request_data} \
-     --request POST ${base_path}/v2/accounts/${account_id}/templates \
+     --request POST ${base_path}/v2.1/accounts/${account_id}/templates \
      --output $response
 
 echo ""

examples/eg009UseTemplate.sh

@@ -52,7 +52,7 @@ curl --header "Authorization: Bearer ${access_token}" \
     ],
     \"status\": \"sent\"
 }" \
-     --request POST ${base_path}/v2/accounts/${account_id}/envelopes \
+     --request POST ${base_path}/v2.1/accounts/${account_id}/envelopes \
      --output ${response}
 # ***DS.snippet.0.end