-
Notifications
You must be signed in to change notification settings - Fork 17
/
webforms.rest.swagger-v1.1.0.json
1599 lines (1599 loc) · 79.6 KB
/
webforms.rest.swagger-v1.1.0.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Web Forms API version 1.1",
"description": "The Web Forms API facilitates generating semantic HTML forms around everyday contracts.\n",
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/web",
"contact": {
"name": "DocuSign Developer Center",
"email": "[email protected]",
"url": "https://developers.docusign.com/"
},
"version": "1.1.0",
"x-ds-platform-version": "20.3.000"
},
"security": [
{
"DocuSignAuth": []
}
],
"host": "apps.docusign.com",
"basePath": "/api/webforms",
"schemes": [
"https"
],
"paths": {
"/v1.1/accounts/{accountId}/forms": {
"get": {
"summary": "Returns a list of web form configurations.",
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[Docusign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nThis method returns a list of web form configurations for a given account. Use the query parameters to sort and filter the response.\n\n[Required authentication scopes](/docs/web-forms-api/plan-integration/authentication/): `webforms_read`.",
"operationId": "WebForm_ListForms",
"x-ds-methodname": "listForms",
"tags": [
"Configurations"
],
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "The ID of the account to which the web form belongs.\n",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "user_filter",
"description": "Set to `owned_by_me` to return only forms owned by the authenticated user. By default, all forms are returned.",
"type": "string",
"enum": [
"owned_by_me",
"all"
],
"default": "all"
},
{
"in": "query",
"name": "is_standalone",
"description": "Set to `true` or `false` to filter by whether forms are [stand-alone (not tied to a template)](https://support.docusign.com/s/document-item?bundleId=yff1696971835267&topicId=gua1698120920620.html). By default, all forms are returned.",
"type": "boolean",
"required": false
},
{
"in": "query",
"name": "is_published",
"description": "When `true`, only published forms are returned. By default, published and unpublished forms are both returned.",
"type": "boolean",
"required": false
},
{
"in": "query",
"name": "sort_by",
"description": "Sorts the results. You can sort by the time that the web forms were created or last modified, in descending or ascending order. Valid values:\n\n* `lastModifiedDateTime:desc` (default)\n* `lastModifiedDateTime:asc`\n* `createdDateTime:desc`\n* `createdDateTime:asc`",
"type": "string",
"maxLength": 50,
"required": false
},
{
"in": "query",
"name": "search",
"description": "When set, filters results by whether each web form configuration contains the given text in its `formProperties.name` property.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "start_position",
"description": "The zero-based index of the result from which to start returning results.\n\nUse with `count` to limit the number of results.\n\nThe default value is 0.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "count",
"description": "The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "A list of forms assigned to the account",
"schema": {
"$ref": "#/definitions/WebFormSummaryList"
}
},
"401": {
"description": "The authentication information is either missing or invalid",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"403": {
"description": "The requestor is not authorized",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"404": {
"description": "The requested resource was not found",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/HttpError"
}
}
},
"security": [
{
"DocuSignAuth": [
"webforms_read"
]
}
],
"x-ds-method": "listForms",
"x-ds-service": "Form Management",
"x-ds-in-sdk": true
}
},
"/v1.1/accounts/{accountId}/forms/{formId}": {
"get": {
"summary": "Retrieves a web form configuration.",
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[Docusign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nRetrieves a web form configuration.\n\nIf you make changes to an active form configuration, the unchanged active version will also be maintained. The two versions will have the same `formId` but different `formState` values. Use the `state` query parameter to indicate which version to return.\n\n[Required authentication scopes](/docs/web-forms-api/plan-integration/authentication/): `webforms_read`.",
"operationId": "WebForm_GetForm",
"x-ds-methodname": "getForm",
"tags": [
"Configurations"
],
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "The ID of the account to which the web form belongs.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "formId",
"description": "The ID of the web form configuration.\n",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "state",
"description": "The state of the web form configuration. Valid values:\n\n- `active`\n- `draft`",
"type": "string",
"default": "draft",
"enum": [
"active",
"draft"
],
"maxLength": 15,
"required": false
}
],
"responses": {
"200": {
"description": "Web Form that represents a single active version with metadata",
"schema": {
"$ref": "#/definitions/WebForm"
}
},
"401": {
"description": "The authentication information is either missing or invalid",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"404": {
"description": "The requested resource was not found",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/HttpError"
}
}
},
"security": [
{
"DocuSignAuth": [
"webforms_read"
]
}
],
"x-ds-method": "getForm",
"x-ds-service": "Form Management",
"x-ds-in-sdk": true
}
},
"/v1.1/accounts/{accountId}/forms/{formId}/instances": {
"get": {
"summary": "Lists the instances of a given web form configuration.",
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[Docusign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nRetrieves all the instances of a given web form configuration.\n\n[Required authentication scopes](/docs/web-forms-api/plan-integration/authentication/): `webforms_instance_read`.",
"operationId": "WebFormInstance_ListInstances",
"x-ds-methodname": "listInstances",
"tags": [
"Instances"
],
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "The ID of the account to which the web form belongs.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "formId",
"description": "The ID of the form configuration.\n",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "client_user_id",
"description": "A unique identifier for a user from the client's system. This value can be anything your backend system would use to track individual form instances, such as employee IDs, email addresses, or surrogate key values.",
"type": "string",
"maxLength": 100,
"required": false
}
],
"responses": {
"200": {
"description": "List of all Web Form Instances with associated metadata.",
"schema": {
"$ref": "#/definitions/WebFormInstanceList"
}
},
"401": {
"description": "The authentication information is either missing or invalid",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"403": {
"description": "The requestor is not authorized",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"404": {
"description": "The requested resource is not found",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"500": {
"description": "The service encountered an unexpected condition that prevented it from fulfilling the request",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"503": {
"description": "Service is temporarily unavailable",
"schema": {
"$ref": "#/definitions/HttpError"
}
}
},
"security": [
{
"DocuSignAuth": [
"webforms_instance_read"
]
}
],
"x-ds-method": "listInstances",
"x-ds-service": "Form Instance Management",
"x-ds-in-sdk": true
},
"post": {
"summary": "Gets a web form instance.",
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[Docusign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nCreates an instance of a web form.\n\nThis endpoint returns a `formUrl` and `instanceToken` that you combine to obtain a secure URL. Use this URL to render the web form instance in your application.\n\n[Required authentication scopes](/docs/web-forms-api/plan-integration/authentication/): `webforms_instance_write`.\n\n\n### Related topics\n\n- [How to create and embed a web form instance](/docs/web-forms-api/how-to/create-embed-web-form-instance/)",
"operationId": "WebFormInstance_CreateInstance",
"x-ds-methodname": "createInstance",
"tags": [
"Instances"
],
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "The ID of the account to which the web form belongs.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "formId",
"description": "The ID of the web form configuration.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "create_instance_body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/CreateInstanceRequestBody"
}
}
],
"responses": {
"200": {
"description": "Web Form Instance with metadata",
"schema": {
"$ref": "#/definitions/WebFormInstance"
}
},
"400": {
"description": "The form instance cannot be created, possibly due to validation failure.",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"401": {
"description": "The authentication information is either missing or invalid",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"403": {
"description": "The requestor is not authorized",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"404": {
"description": "The requested resource is not found",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"500": {
"description": "The service encountered an unexpected condition that prevented it from fulfilling the request",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"503": {
"description": "service is temporarily unavailable",
"schema": {
"$ref": "#/definitions/HttpError"
}
}
},
"security": [
{
"DocuSignAuth": [
"webforms_instance_write"
]
}
],
"x-ds-method": "createInstance",
"x-ds-service": "Form Instance Management",
"x-ds-in-sdk": true
}
},
"/v1.1/accounts/{accountId}/forms/{formId}/instances/{instanceId}": {
"get": {
"summary": "Creates a secure web form instance.",
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[Docusign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nGets an instance of a web form specified by the configuration and instance IDs. To get all instances associated with a given configuration, use the [listInstances endpoint](/docs/web-forms-api/reference/webforms/instances/listinstances/).\n\n[Required authentication scopes](/docs/web-forms-api/plan-integration/authentication/): `webforms_instance_read`.",
"operationId": "WebFormInstance_GetInstance",
"x-ds-methodname": "getInstance",
"tags": [
"Instances"
],
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "The ID of the account to which the web form belongs.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "formId",
"description": "The ID of the web form configuration.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "instanceId",
"description": "The ID of the form instance.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Web Form Instance with metadata",
"schema": {
"$ref": "#/definitions/WebFormInstance"
}
},
"401": {
"description": "The authentication information is either missing or invalid",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"403": {
"description": "The requestor is not authorized",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"404": {
"description": "The requested resource is not found",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"500": {
"description": "The service encountered an unexpected condition that prevented it from fulfilling the request",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"503": {
"description": "service is temporarily unavailable",
"schema": {
"$ref": "#/definitions/HttpError"
}
}
},
"security": [
{
"DocuSignAuth": [
"webforms_instance_read"
]
}
],
"x-ds-method": "getInstance",
"x-ds-service": "Form Instance Management",
"x-ds-in-sdk": true
}
},
"/v1.1/accounts/{accountId}/forms/{formId}/instances/{instanceId}/refresh": {
"post": {
"summary": "Refreshes the instance token.",
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[Docusign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nGenerates a new instance token for an existing web form instance. Tokens expire after five minutes.\n\n[Required authentication scopes](/docs/web-forms-api/plan-integration/authentication/): `webforms_instance_write`.",
"operationId": "WebFormInstance_RefreshToken",
"x-ds-methodname": "refreshToken",
"tags": [
"Instances"
],
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "The ID of the account to which the web form belongs.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "formId",
"description": "The ID of the web form configuration.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "instanceId",
"description": "The ID of the form instance.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Web Form Instance with new instance token and metadata",
"schema": {
"$ref": "#/definitions/WebFormInstance"
}
},
"400": {
"description": "The instance token cannot be created, possibly because the validation failed.",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"401": {
"description": "The authentication information is either missing or invalid",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"403": {
"description": "The requestor is not authorized",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"404": {
"description": "The requested resource is not found",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"500": {
"description": "The service encountered an unexpected condition that prevented it from fulfilling the request",
"schema": {
"$ref": "#/definitions/HttpError"
}
},
"503": {
"description": "service is temporarily unavailable",
"schema": {
"$ref": "#/definitions/HttpError"
}
}
},
"security": [
{
"DocuSignAuth": [
"webforms_instance_write"
]
}
],
"x-ds-method": "refreshToken",
"x-ds-service": "Form Instance Management",
"x-ds-in-sdk": true
}
}
},
"securityDefinitions": {
"DocuSignAuth": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "https://account-tk1.tk.docusign.dev/oauth/auth",
"tokenUrl": "https://account-tk1.tk.docusign.dev/oauth/token",
"scopes": {
"webforms_read": "Read web form configuration",
"webforms_write": "Create web form and modify web form configuration",
"webforms_instance_read": "Read instance configuration",
"webforms_instance_write": "Create instance and modify instance configuration"
}
}
},
"definitions": {
"Guid": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "Guid",
"description": "",
"x-ms-summary": ""
},
"UserId": {
"description": "DocuSign user identifier",
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "UserId",
"x-ms-summary": "DocuSign user identifier"
},
"AccountId": {
"description": "Account identifier in which the webform resides",
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "AccountId",
"x-ms-summary": "Account identifier in which the webform resides"
},
"WebFormId": {
"description": "Unique identifier for a webform entity that is consistent for it's lifetime",
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "WebFormId",
"x-ms-summary": "Unique identifier for a webform entity that is consistent for it's lifetime"
},
"InstanceId": {
"description": "Unique identifier for a webform instance that is consistent until its expiration",
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "InstanceId",
"x-ms-summary": "Unique identifier for a webform instance that is consistent until its expiration"
},
"EnvelopeId": {
"description": "Envelope Id",
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "EnvelopeId",
"x-ms-summary": "Envelope Id"
},
"ExpirationDateTime": {
"description": "The DateTime after which the webform instance is inaccessible.",
"type": "string",
"format": "date-time",
"x-ds-definition-name": "ExpirationDateTime",
"x-ms-summary": "The DateTime after which the webform instance is inaccessible."
},
"CreatedDateTime": {
"description": "The DateTime when the webform instance is created.",
"type": "string",
"format": "date-time",
"x-ds-definition-name": "CreatedDateTime",
"x-ms-summary": "The DateTime when the webform instance is created."
},
"LastModifiedDateTime": {
"description": "The DateTime when the webform instance is last modified.",
"type": "string",
"format": "date-time",
"x-ds-definition-name": "LastModifiedDateTime",
"x-ms-summary": "The DateTime when the webform instance is last modified."
},
"IsStandalone": {
"description": "Is the form a standalone form",
"type": "boolean",
"x-ds-definition-name": "IsStandalone",
"x-ms-summary": "Is the form a standalone form"
},
"InstanceToken": {
"type": "string",
"description": "Unique token associated with an instance that is required to render the form instance. This token is valid for 5 minutes after which it needs to be refreshed using refreshToken api",
"x-ds-definition-name": "InstanceToken",
"x-ms-summary": "Unique token associated with an instance that is required to render the form instance. This token is valid for 5 minutes after which it needs to be refreshed using refreshToken api"
},
"TokenExpirationDateTime": {
"description": "The DateTime after which the token is expired and form instance is inaccessible.",
"type": "string",
"format": "date-time",
"x-ds-definition-name": "TokenExpirationDateTime",
"x-ms-summary": "The DateTime after which the token is expired and form instance is inaccessible."
},
"FormUrl": {
"type": "string",
"description": "The instance url which can be rendered by the user",
"example": "https://webforms-ux/v1.0/forms/82356c8f286b4e4df592af7d0984f51d",
"x-ds-definition-name": "FormUrl",
"x-ms-summary": "The instance url which can be rendered by the user"
},
"InstanceStatus": {
"type": "string",
"description": "The status of the form instance",
"enum": [
"INITIATED",
"IN_PROGRESS",
"SUBMITTED",
"EXPIRED",
"FAILED"
],
"example": "INITIATED",
"maxLength": 15,
"x-ds-definition-name": "InstanceStatus",
"x-ms-summary": "The status of the form instance"
},
"InstanceSource": {
"type": "string",
"description": "The method by which the form instance is created.\n",
"enum": [
"PUBLIC_URL",
"API_EMBEDDED",
"API_REMOTE",
"UI_REMOTE",
"WORKFLOW"
],
"example": "API_EMBEDDED",
"maxLength": 20,
"x-ds-definition-name": "InstanceSource",
"x-ms-summary": "The method by which the form instance is created.\n"
},
"ClientUserId": {
"type": "string",
"description": "A unique identifier for a user that should originate from client's system. This value can be anything your backend system would use to track individual form instances. Examples include employee IDs, email addresses, surrogate key values, etc.",
"example": "[email protected]",
"maxLength": 100,
"x-ds-definition-name": "ClientUserId",
"x-ms-summary": "A unique identifier for a user that should originate from client's system. This value can be anything your backend system would use to track individual form instances. Examples include employee IDs, email addresses, surrogate key values, etc."
},
"AuthenticationInstant": {
"type": "string",
"description": "A sender-generated value that indicates the date and time that the signer was authenticated.",
"x-ds-definition-name": "AuthenticationInstant",
"x-ms-summary": "A sender-generated value that indicates the date and time that the signer was authenticated."
},
"AuthenticationMethod": {
"type": "string",
"description": "A value that most closely matches the technique your application used to authenticate the recipient / signer.",
"example": "Biometric, Email, HTTPBasicAuth, Kerberos etc",
"maxLength": 40,
"enum": [
"Biometric",
"Email",
"HTTPBasicAuth",
"Kerberos",
"KnowledgeBasedAuth",
"None",
"PaperDocuments",
"Password",
"RSASecureID",
"SingleSignOn_CASiteminder",
"SingleSignOn_InfoCard",
"SingleSignOn_MicrosoftActiveDirectory",
"SingleSignOn_Other",
"SingleSignOn_Passport",
"SingleSignOn_SAML",
"Smartcard",
"SSLMutualAuth",
"X509Certificate"
],
"x-ds-definition-name": "AuthenticationMethod",
"x-ms-summary": "A value that most closely matches the technique your application used to authenticate the recipient / signer."
},
"AssertionId": {
"type": "string",
"description": "A unique identifier of the authentication event executed by the client application.",
"example": "client-12345",
"x-ds-definition-name": "AssertionId",
"x-ms-summary": "A unique identifier of the authentication event executed by the client application."
},
"SecurityDomain": {
"type": "string",
"description": "The domain in which the user authenticated.",
"x-ds-definition-name": "SecurityDomain",
"x-ms-summary": "The domain in which the user authenticated."
},
"ReturnUrl": {
"type": "string",
"description": "The url to which the user is redirected after the signing is completed",
"example": "http://www.thankyoupage.com",
"x-ds-definition-name": "ReturnUrl",
"x-ms-summary": "The url to which the user is redirected after the signing is completed"
},
"ExpirationOffset": {
"type": "integer",
"minimum": 1,
"maximum": 23976,
"format": "int64",
"description": "Specify the number of hours after which the form instance expires. For example, if the form expiration is set to 5 days, you should specify 120. The default value is 720 hours (30 days).",
"example": 120,
"x-ds-definition-name": "ExpirationOffset",
"x-ms-summary": "Specify the number of hours after which the form instance expires. For example, if the form expiration is set to 5 days, you should specify 120. The default value is 720 hours (30 days)."
},
"WebFormUserInfo": {
"type": "object",
"description": "A DocuSign user within the account associated with the form.",
"properties": {
"userId": {
"$ref": "#/definitions/UserId",
"description": "The ID of the Docusign user."
},
"userName": {
"type": "string",
"maxLength": 150,
"example": "John Doe",
"description": "The user's name that will be displayed in the UI. The maximum length is 150 characters."
}
},
"x-ds-definition-name": "WebFormUserInfo",
"x-ms-summary": "A DocuSign user within the account associated with the form."
},
"WebFormSource": {
"type": "string",
"description": "The source from which the webform is created.",
"enum": [
"templates",
"blank",
"form"
],
"example": "templates",
"maxLength": 15,
"x-ds-definition-name": "WebFormSource",
"x-ms-summary": "The source from which the webform is created."
},
"WebFormType": {
"type": "string",
"description": "Indicates whether the web form is standalone or attached to an eSignature template.",
"enum": [
"standalone",
"hasEsignTemplate"
],
"example": "standalone",
"maxLength": 20,
"x-ds-definition-name": "WebFormType",
"x-ms-summary": "Indicates whether the web form is standalone or attached to an eSignature template."
},
"CreateInstanceRequestBody": {
"type": "object",
"description": "The request body for the `Instances::createInstance` endpoint.",
"required": [
"clientUserId"
],
"properties": {
"formValues": {
"$ref": "#/definitions/WebFormValues",
"description": "Key-value pairs used to prefill fields in the web form instance. The keys correspond to the values of the `publishedComponentNames` object on the `WebForm` (configuration) object.\n\nFor keys of type TextBox, Email, Date, Select, and RadioButtonGroup, the value should be a string. For keys of type Number, the value should be a number. For keys of type of CheckboxGroup, the value should be an array of strings.\n\nFor example, a web form configuration might have the following properties indicated by the `publishedComponentNames` object:\n```\n\"publishedComponentNames\": {\n \"Signer_name\": \"TextBox\",\n \"Signer_email\": \"Email\",\n \"Dropdown\": \"Select\",\n \"Hobbies\": \"CheckboxGroup\"\n}\n```\n\nThen, this property might be:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"[email protected]\",\n \"Hobbies\": [\"walking\", \"napping\"]\n}\n```\n\nNote that you do not have to include values for every component. This property is **optional.**"
},
"clientUserId": {
"$ref": "#/definitions/ClientUserId",
"description": "A unique identifier for a user from the client's system. This value can be anything your backend system would use to track individual web form instances, such as employee IDs, email addresses, or surrogate key values.\n\nThis property is **required.** The maximum length is 100 characters."
},
"authenticationInstant": {
"$ref": "#/definitions/AuthenticationInstant",
"description": "Set this value to indicate the date and time that the signer was authenticated.\n\nThis property is **optional.** If it is provided, the value will be included in the corresponding envelopes' certificates of completion."
},
"authenticationMethod": {
"$ref": "#/definitions/AuthenticationMethod",
"description": "Set this value to indicate the technique your application used to authenticate the user.\n\nThis property is **optional.** The maximum length is 40 characters. If it is provided, this property will be included in the corresponding envelopes' certificates of completion."
},
"assertionId": {
"$ref": "#/definitions/AssertionId",
"description": "Set this value to identify the authentication event executed by your application.\n\nThis property is **optional.** If it is provided, this property will be included in the corresponding envelopes' certificates of completion."
},
"securityDomain": {
"$ref": "#/definitions/SecurityDomain",
"description": "Set this value to indicate the domain in which the user authenticated.\n\nThis property is **optional.** If it is provided, this property will be included in the corresponding envelopes' certificates of completion."
},
"returnUrl": {
"$ref": "#/definitions/ReturnUrl",
"description": "The URL to which the user is redirected after the signing is completed. This property is **optional.**"
},
"expirationOffset": {
"$ref": "#/definitions/ExpirationOffset",
"description": "The number of hours after which the web form instance expires. For example, if you want the instance to expire after 5 days, set this property to `120`.\n\nThis property is **optional.** The default value is `720` (30 days)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Set this metadata to help your application identify the web form instance. The default value is `[]`. \n\nExample value: `[\"Client A\", \"Agreement Category B\"]`\n\nThis property is **optional.**",
"maxLength": 50,
"example": [
"loan_application",
"finance_dept"
]
}
},
"x-ds-definition-name": "CreateInstanceRequestBody",
"x-ms-summary": "The request body for the `Instances::createInstance` endpoint."
},
"WebFormInstanceMetadata": {
"description": "Metadata associated with the web form instance.",
"type": "object",
"required": [
"expirationDateTime",
"createdBy",
"createdDateTime"
],
"properties": {
"expirationDateTime": {
"$ref": "#/definitions/ExpirationDateTime",
"description": "The DateTime after which the web form instance will be inaccessible."
},
"createdDateTime": {
"$ref": "#/definitions/CreatedDateTime",
"description": "The DateTime at which the web form instance was created."
},
"createdBy": {
"description": "The user that created the web form instance.",
"$ref": "#/definitions/WebFormUserInfo"
},
"lastModifiedDateTime": {
"$ref": "#/definitions/LastModifiedDateTime",
"description": "The DateTime at which the web form instance was last modified."
},
"lastModifiedBy": {
"description": "The user who last modified the web form instance.",
"$ref": "#/definitions/WebFormUserInfo"
}
},
"example": {
"expirationDateTime": "2023-08-16T10:30:00Z",
"createdBy": {
"userId": "00000000-0000-0000-0000-000000000000",
"userName": "DocuSign User"
},
"createdDateTime": "2023-08-15T10:30:00Z",
"lastModifiedBy": {
"userId": "00000000-0000-0000-0000-000000000000",
"userName": "DocuSign User"
},
"lastModifiedDateTime": "2023-08-15T20:30:00Z"
},
"x-ds-definition-name": "WebFormInstanceMetadata",
"x-ms-summary": "Metadata associated with the web form instance."
},
"WebFormInstanceList": {
"description": "A list of web form instance items.",
"type": "object",
"properties": {
"items": {
"description": "Array of web form instance items.",
"type": "array",
"items": {
"$ref": "#/definitions/WebFormInstance"
}
}
},
"x-ds-definition-name": "WebFormInstanceList",
"x-ms-summary": "A list of web form instance items."
},
"WebFormInstance": {
"type": "object",
"description": "An object that contains the instance url required to render the webform instance and its metadata such as created by, created time",
"required": [
"id"
],
"properties": {
"formUrl": {
"$ref": "#/definitions/FormUrl",
"description": "The base URL to render the web form instance. This value is the same for every instance created from the same configuration."
},
"instanceToken": {
"$ref": "#/definitions/InstanceToken",
"description": "The instance token for the web form instance. To obtain the secure URL for your web form instance, append this value to the `formUrl` value in the following format:\n`https://[formUrl]#instanceToken=[instanceToken]`\n\nThe token expires after five minutes. To get a new token, call the [refreshToken](/docs/webforms-api/reference/webforms/instances/refreshtoken/) endpoint."
},
"tokenExpirationDateTime": {
"$ref": "#/definitions/TokenExpirationDateTime",
"description": "The DateTime after which the token expires."
},
"id": {
"$ref": "#/definitions/InstanceId",
"description": "The unique ID of the web form instance."
},
"formId": {
"description": "The ID of the form configuration from which the form instance was created.",
"$ref": "#/definitions/WebFormId"
},
"accountId": {
"$ref": "#/definitions/AccountId",
"description": "The account ID GUID."
},
"clientUserId": {
"$ref": "#/definitions/ClientUserId",
"description": "A unique identifier for a user from the client's system."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Metadata to help your application identify the web form instance.\n\nExample: `[\"Client A\", \"Agreement Category B\"]`",
"maxLength": 50,
"example": [
"loan_application",
"finance_dept"
]
},
"status": {
"$ref": "#/definitions/InstanceStatus",
"description": "The status of the web form instance. Valid values:\n\n* `INITIATED`: The web form instance is accessible and can be opened until it is submitted or expires.\n* `SUBMITTED`: The instance has been submitted and cannot be opened again.\n* `INPROGRESS`: The user has saved their progress, but has not yet submitted the form instance.\n* `EXPIRED`: The instance has expired.\n* `FAILED`: The instance has failed."
},
"envelopes": {
"description": "The associated envelope that is created when the instance is submitted",
"type": "array",
"items": {
"type": "object",
"properties": {