Skip to content

Commit ecd534b

Browse files
authored
Merge pull request docusign#6 from docusign/Updating-for-IDV
Updating for idv
2 parents d5fcfa6 + bd7d8e4 commit ecd534b

File tree

3 files changed

+68
-50
lines changed

3 files changed

+68
-50
lines changed

README.md

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,50 +9,80 @@ This repo is a Python 3 application that demonstrates:
99
When the token expires, the user is asked to re-authenticate.
1010
The **refresh token** is not used in this example.
1111
1. **Embedded Signing Ceremony.**
12-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg001_embedded_signing.py)
12+
[Source.](./app/eg001_embedded_signing.py)
1313
This example sends an envelope, and then uses an embedded signing ceremony for the first signer.
1414
With embedded signing, the DocuSign signing ceremony is initiated from your website.
1515
1. **Send an envelope with a remote (email) signer and cc recipient.**
16-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg002_signing_via_email.py)
16+
[Source.](./app/eg002_signing_via_email.py)
1717
The envelope includes a pdf, Word, and HTML document.
1818
Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents.
1919
1. **List envelopes in the user's account.**
20-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg003_list_envelopes.py)
20+
[Source.](./app/eg003_list_envelopes.py)
2121
The envelopes' current status is included.
2222
1. **Get an envelope's basic information.**
23-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg004_envelope_info.py)
23+
[Source.](./app/eg004_envelope_info.py)
2424
The example lists the basic information about an envelope, including its overall status.
2525
1. **List an envelope's recipients**
26-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg005_envelope_recipients.py)
26+
[Source.](./app/eg005_envelope_recipients.py)
2727
Includes current recipient status.
2828
1. **List an envelope's documents.**
29-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg006_envelope_docs.py)
29+
[Source.](./app/eg006_envelope_docs.py)
3030
1. **Download an envelope's documents.**
31-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg007_envelope_get_doc.py)
31+
[Source.](./app/eg007_envelope_get_doc.py)
3232
The example can download individual
3333
documents, the documents concatenated together, or a zip file of the documents.
3434
1. **Programmatically create a template.**
35-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg008_create_template.py)
35+
[Source.](./app/eg008_create_template.py)
3636
1. **Send an envelope using a template.**
37-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg009_use_template.py)
37+
[Source.](./app/eg009_use_template.py)
3838
1. **Send an envelope and upload its documents with multpart binary transfer.**
39-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg010_send_binary_docs.py)
39+
[Source.](./app/eg010_send_binary_docs.py)
4040
Binary transfer is 33% more efficient than using Base64 encoding.
4141
1. **Embedded sending.**
42-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg011_embedded_sending.py)
42+
[Source.](./app/eg011_embedded_sending.py)
4343
Embeds the DocuSign web tool (NDSE) in your web app to finalize or update
4444
the envelope and documents before they are sent.
4545
1. **Embedded DocuSign web tool (NDSE).**
46-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg012_embedded_console.py)
46+
[Source.](./app/eg012_embedded_console.py)
4747
1. **Embedded Signing Ceremony from a template with an added document.**
48-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg013_add_doc_to_template.py)
48+
[Source.](./app/eg013_add_doc_to_template.py)
4949
This example sends an envelope based on a template.
5050
In addition to the template's document(s), the example adds an
5151
additional document to the envelope by using the
5252
[Composite Templates](https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates)
5353
feature.
5454
1. **Payments example: an order form, with online payment by credit card.**
55-
[Source.](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/app/eg014_collect_payment.py)
55+
[Source.](./app/eg014_collect_payment.py)
56+
1. **Get the envelope tab data.**
57+
Retrieve the tab (field) values for all of the envelope's recipients.
58+
[Source.](./app/eg015_envelope_tab_data.py)
59+
1. **Set envelope tab values.**
60+
The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs
61+
are set to be read-only, others can be updated by the recipient. The example also stores
62+
metadata with the envelope.
63+
[Source.](./app/eg016_set_tab_values.py)
64+
1. **Set template tab values.**
65+
The example creates an envelope using a template and sets the initial values for its tabs (fields).
66+
The example also stores metadata with the envelope.
67+
[Source.](./app/eg017_set_template_tab_values.py)
68+
1. **Get the envelope custom field data (metadata).**
69+
The example retrieves the custom metadata (custom data fields) stored with the envelope.
70+
[Source.](./app/eg018_envelope_custom_field_data.py)
71+
1. **Requiring an Access Code for a Recipient**
72+
[Source.](./app/eg019_access_code_authentication.py)
73+
This example sends an envelope that requires an access-code for the purpose of multi-factor authentication.
74+
1. **Requiring SMS authentication for a recipient**
75+
[Source.](./app/eg020_sms_authentication.py)
76+
This example sends an envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication.
77+
1. **Requiring Phone authentication for a recipient**
78+
[Source.](./app/eg021_phone_authentication.py)
79+
This example sends an envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication.
80+
1. **Requiring Knowledge-Based Authentication (KBA) for a Recipient**
81+
[Source.](./app/eg022_kba_authentication.py)
82+
This example sends an envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication.
83+
1. **Requiring ID Verification (IDV) for a recipient**
84+
[Source.](./app/eg023_idv_authentication.py)
85+
This example sends an envelope that requires submitting a photo of a government issued id for the purpose of multi-factor authentication.
5686

5787
## Installation
5888

app/eg010_send_binary_docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ def worker(args):
155155

156156
# Step 2. call Envelopes::create API method
157157
# Exceptions will be caught by the calling function
158-
results = requests.post(f"{args['base_path']}/v2/accounts/{args['account_id']}/envelopes",
158+
results = requests.post(f"{args['base_path']}/v2.1/accounts/{args['account_id']}/envelopes",
159159
headers = {
160160
"Authorization": "bearer " + args["ds_access_token"],
161161
"Accept": "application/json",

app/eg023_idv_authentication.py

Lines changed: 23 additions & 35 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)