-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
8641 lines (8634 loc) · 280 KB
/
openapi.yaml
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
openapi: 3.0.1
info:
title: Resources and endpoints
description: >-
When I started SignWell in 2019, I saw there was a need for an alternative
to the hard-to-use and expensive e-signature software already out there.
Documents can be complicated enough, but getting a document signed shouldn't
be complicated too.
At SignWell, we pride ourselves not only on the ease and affordability of
our e-signature process but also on our personalized and industry-leading
customer support — whether it's for individual use or larger team accounts,
SignWell is here to help you feel comfortable and confident getting your
documents signed.
The SignWell mission? Simplify how documents get signed for millions of
people and businesses. We're excited to help you continue to move toward the
future of paperless document signing.
Ruben Gamez
Founder, SignWell
version: '1'
x-api-status-urls: false
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.signwell.com
tags:
- name: Document
- name: Bulk Send
- name: Template
- name: Webhooks
- name: API Application
- name: Me
paths:
/api/v1/documents/{id}/remind:
post:
tags:
- Document
summary: Send Reminder
operationId: Document_sendReminder
security:
- api_key: []
description: Sends a reminder email to recipients that have not signed yet.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/document_id_param_map'
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/send_reminder_request'
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSendReminderResponse'
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSendReminder404Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSendReminder422Response'
/api/v1/bulk_sends/{id}:
get:
tags:
- Bulk Send
summary: Get Bulk Send
operationId: BulkSend_getInformation
security:
- api_key: []
description: Returns information about the Bulk Send.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/bulk_send_id_param_map'
required: true
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetInformationResponse'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetInformation401Response'
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetInformation404Response'
/api/v1/bulk_sends:
get:
tags:
- Bulk Send
summary: List Bulk Sendings
operationId: BulkSend_listBulkSendings
security:
- api_key: []
description: Returns information about the Bulk Send.
parameters:
- name: user_email
in: query
required: false
schema:
$ref: '#/components/schemas/user_email_map'
- name: limit
in: query
required: false
schema:
$ref: '#/components/schemas/limit_map'
- name: page
in: query
required: false
schema:
$ref: '#/components/schemas/page_offset_map'
- name: api_application_id
in: query
required: false
schema:
$ref: '#/components/schemas/api_application_id_map'
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendListBulkSendingsResponse'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendListBulkSendings401Response'
post:
tags:
- Bulk Send
summary: Create Bulk Send
operationId: BulkSend_createValidationCsv
security:
- api_key: []
description: >-
Creates a bulk send, and it validates the CSV file before creating the
bulk send.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_bulk_send_request'
responses:
'201':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendCreateValidationCsvResponse'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendCreateValidationCsv401Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendCreateValidationCsv422Response'
/api/v1/bulk_sends/csv_template:
get:
tags:
- Bulk Send
summary: Get Bulk Send CSV Template
operationId: BulkSend_getCsvTemplate
security:
- api_key: []
description: >-
Fetches a CSV template that corresponds to the provided document
template IDs. CSV templates are blank CSV files that have columns
containing required and optional data that can be sent when creating a
bulk send. Fields can be referenced by the field label. Example:
[placeholder name]_[field label] could be something like
customer_address or signer_company_name (if "Customer" and "Signer" were
placeholder names for templates set up in SignWell).
parameters:
- name: template_ids[]
in: query
required: true
schema:
$ref: '#/components/schemas/bulk_send_template_ids_param_map'
- name: base64
in: query
schema:
$ref: '#/components/schemas/bulk_send_csv_map'
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetCsvTemplate200Response'
application/octet-stream:
schema:
$ref: '#/components/schemas/BulkSendGetCsvTemplateResponse'
example: |
document_sender_email,document_sender_name
krombopulos_michael_81@example.com,Krombopulos Michael
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetCsvTemplate401Response'
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetCsvTemplate404Response'
/api/v1/bulk_sends/validate_csv:
post:
tags:
- Bulk Send
summary: Validate Bulk Send CSV
operationId: BulkSend_validateCsv
security:
- api_key: []
description: >-
Validates a Bulk Send CSV file before creating the Bulk Send. It will
check the structure of the CSV and the data it contains, and return any
errors found.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/bulk_send_csv_request'
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendValidateCsvResponse'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendValidateCsv401Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendValidateCsv422Response'
/api/v1/bulk_sends/{id}/documents:
get:
tags:
- Bulk Send
summary: Get Bulk Send Documents
operationId: BulkSend_getDocuments
security:
- api_key: []
description: Returns information about the Bulk Send.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/bulk_send_id_param_map'
required: true
- name: limit
in: query
required: false
schema:
$ref: '#/components/schemas/limit_map'
- name: page
in: query
required: false
schema:
$ref: '#/components/schemas/page_offset_map'
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetDocumentsResponse'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetDocuments401Response'
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/BulkSendGetDocuments404Response'
/api/v1/documents/{id}:
get:
tags:
- Document
summary: Get Document
operationId: Document_getDocumentData
security:
- api_key: []
description: >-
Returns a document and all associated document data. Supply the unique
document ID from either a document creation request or Document page
URL.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/document_id_param_map'
required: true
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentGetDocumentDataResponse'
'404':
description: not_found
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentGetDocumentData404Response'
delete:
tags:
- Document
summary: Delete Document
operationId: Document_deleteDocument
security:
- api_key: []
description: >-
Deletes a document. Deleting a document will also cancel document
signing (if in progress). Supply the unique document ID from either a
Create Document request or document page URL.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/document_id_param_map'
required: true
responses:
'204':
description: no content
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentDeleteDocumentResponse'
/api/v1/documents:
post:
tags:
- Document
summary: Create Document
operationId: Document_createNewDocument
security:
- api_key: []
description: >-
Creates and optionally sends a new document for signing. If `draft` is
set to false the document will not be sent.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/document_request'
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreateNewDocumentResponse'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreateNewDocument400Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreateNewDocument422Response'
/api/v1/document_templates/documents:
post:
tags:
- Document
summary: Create Document from Template
operationId: Document_createFromTemplate
security:
- api_key: []
description: >-
Creates and optionally sends a new document for signing. If `draft` is
set to false the document will not be sent.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/document_from_template_request'
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreateFromTemplateResponse'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreateFromTemplate400Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreateFromTemplate422Response'
/api/v1/documents/{id}/send:
post:
tags:
- Document
summary: Update and Send Document
operationId: Document_updateAndSend
security:
- api_key: []
description: Updates a draft document and sends it to be signed by recipients.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/document_id_param_map'
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/update_document_and_send_request'
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdateAndSendResponse'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdateAndSend422Response'
/api/v1/documents/{id}/completed_pdf:
get:
tags:
- Document
summary: Completed PDF
operationId: Document_getCompletedPdf
security:
- api_key: []
description: >-
Gets a completed document PDF. Supply the unique document ID from either
a document creation request or document page URL.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/document_completed_id_map'
required: true
- name: url_only
in: query
schema:
$ref: '#/components/schemas/url_only_map'
- name: audit_page
in: query
schema:
$ref: '#/components/schemas/audit_page_map'
responses:
'200':
description: >-
successful, returns the final completed PDF, or if url_only is set
to true, a JSON object is returned.
content:
application/json:
example:
file_url: >-
https://www.signwell.com/signed/arJlWX0qmrcXV8G8gJo9ujp3Ggy.pdf?audit_page=true
schema:
$ref: '#/components/schemas/DocumentGetCompletedPdfResponse'
'404':
description: not_found
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentGetCompletedPdf404Response'
/api/v1/document_templates/{id}:
get:
tags:
- Template
summary: Get Template
operationId: Template_getTemplateData
security:
- api_key: []
description: >-
Returns a template and all associated template data. Supply the unique
template ID from either a Create Template request or template page URL.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/template_id_param_map'
required: true
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateGetTemplateDataResponse'
'404':
description: not_found
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateGetTemplateData404Response'
put:
tags:
- Template
summary: Update Template
operationId: Template_updateExistingTemplate
security:
- api_key: []
description: Updates an existing template.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/template_id_param_map'
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/document_template_update_request'
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateUpdateExistingTemplateResponse'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateUpdateExistingTemplate400Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateUpdateExistingTemplate422Response'
delete:
tags:
- Template
summary: Delete Template
operationId: Template_deleteDocumentTemplate
security:
- api_key: []
description: >-
Deletes a template. Supply the unique template ID from either a Create
Template request or template page URL.
parameters:
- name: id
in: path
schema:
$ref: '#/components/schemas/template_id_param_map'
required: true
responses:
'204':
description: no content
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateDeleteDocumentTemplateResponse'
/api/v1/document_templates:
post:
tags:
- Template
summary: Create Template
operationId: Template_createNew
security:
- api_key: []
description: Creates a new template.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/document_template_request'
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateNewResponse'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateNew400Response'
'422':
description: unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateNew422Response'
/api/v1/api_applications/{id}:
get:
tags:
- API Application
summary: Get API Application
operationId: ApiApplication_getDetails
security:
- api_key: []
description: >-
Gets the details of a specific API Application within an account. Supply
the unique Application ID from either the Create API Application
response or the API Application edit page.
parameters:
- name: id
in: path
schema:
description: Unique identifier for the API Application.
type: string
format: uuid
required: true
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplicationGetDetailsResponse'
'404':
description: not_found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplicationGetDetails404Response'
delete:
tags:
- API Application
summary: Delete API Application
operationId: ApiApplication_deleteById
security:
- api_key: []
description: >-
Deletes an API Application from an account. Supply the unique
Application ID from either the Create API Application response or the
API Application edit page
parameters:
- name: id
in: path
schema:
description: Unique identifier for the API Application.
type: string
format: uuid
required: true
responses:
'204':
description: no content
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplicationDeleteByIdResponse'
/api/v1/hooks:
get:
tags:
- Webhooks
summary: List Webhooks
operationId: Webhooks_getAll
security:
- api_key: []
description: List all the webhooks in the account.
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksGetAllResponse'
post:
tags:
- Webhooks
summary: Create Webhook
operationId: Webhooks_registerCallbackUrl
security:
- api_key: []
description: Register a callback URL that we will post document events to.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksRegisterCallbackUrlRequest'
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksRegisterCallbackUrlResponse'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksRegisterCallbackUrl400Response'
/api/v1/hooks/{id}:
delete:
tags:
- Webhooks
summary: Delete Webhook
operationId: Webhooks_deleteCallbackUrl
security:
- api_key: []
description: >-
Deletes a registered callback URL that we are posting document events
to.
parameters:
- name: id
in: path
schema:
description: Unique identifier for a webhook.
type: string
format: uuid
required: true
responses:
'204':
description: no content
'404':
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksDeleteCallbackUrlResponse'
/api/v1/me:
get:
tags:
- Me
summary: Get credentials
operationId: Me_getAccountInfo
security:
- api_key: []
description: >-
Retrieves the account information associated with the API key being
used.
responses:
'200':
description: successful
content:
application/json:
schema:
$ref: '#/components/schemas/MeGetAccountInfoResponse'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/MeGetAccountInfo401Response'
components:
securitySchemes:
api_key:
type: apiKey
name: X-Api-Key
in: header
schemas:
additional_fields_map:
description: >-
Fields to be added to any appended files (not existing files). Document
fields placed on a document for collecting data or signatures from
recipients. Field data should be sent as a 2-dimensional JSON array. One
array of fields is needed for each file in the files array. An array of
fields can be empty if you have a file that does not contain any fields.
type: array
items:
description: Array of Fields you're adding to each file.
type: array
items:
type: object
properties:
x:
description: >-
Horizontal value in the coordinates of the field (in pixels).
Coordinates are specific to the page where fields are located.
type: number
format: float
'y':
description: >-
Vertical value in the coordinates of the field (in pixels).
Coordinates are specific to the page where fields are located.
type: number
format: float
page:
description: >-
The page number within the file. If the page does not exist
within the file then the field won't be created.
type: integer
recipient_id:
description: >-
Unique identifier of the recipient assigned to the field.
Recipients assigned to fields will be the only ones that will
see and be able to complete those fields.
type: string
type:
description: >-
Field type of the field. Valid field types: initials,
signatures, checkbox, date, and text. To autofill fields with
contact data, use an autofill field type.
type: string
enum:
- initials
- signature
- checkbox
- date
- text
- autofill_company
- autofill_email
- autofill_first_name
- autofill_last_name
- autofill_name
- autofill_phone
- autofill_title
- autofill_date_signed
required:
description: >-
Whether the field must be completed by the recipient. Defaults
to `true` except for checkbox type fields.
type: boolean
default: true
label:
description: >-
Text and Date fields only: label that is displayed when the
field is empty.
type: string
value:
description: >-
Varies according to the field type. Text fields accept strings
or numbers. Date fields accept Iso8601 date strings. CheckBoxes
accept booleans. Signature and Initials fields can't be signed
through API requests. Autofill text fields accept strings or
numbers.
api_id:
description: >-
Unique identifier of the field. Useful when needing to reference
specific field values or update a document and its fields.
type: string
validation:
description: >-
Text fields only: optional validation for field values. Valid
values: numbers, letters, email_address, us_phone_number,
us_zip_code, us_ssn, us_age, alphanumeric,
us_bank_routing_number, us_bank_account.
type: string
enum:
- no_text_validation
- numbers
- letters
- email_address
- us_phone_number
- us_zip_code
- us_ssn
- us_age
- alphanumeric
- us_bank_routing_number
- us_bank_account_number
fixed_width:
description: >-
Text fields only: whether the field width will stay fixed and
text will display in multiple lines, rather than one long line.
If set to `false` the field width will automatically grow
horizontally to fit text on one line. Defaults to `false`.
type: boolean
default: false
lock_sign_date:
description: >-
Date fields only: makes fields readonly and automatically
populates with the date the recipient signed. Defaults to
`false`.
type: boolean
default: false
date_format:
description: >-
Date fields only: date format to use for the field. Valid
values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, and
MM/DD/YYYY hh:mm:ss a. Defaults to MM/DD/YYYY.
type: string
enum:
- MM/DD/YYYY
- DD/MM/YYYY
- YYYY/MM/DD
- Month DD, YYYY
- MM/DD/YYYY hh:mm:ss a
required:
- x
- 'y'
- page
- recipient_id
- type
additional_files_map:
type: array
items:
description: >-
Additional files to be appended to the document. Will not replace
existing files from the template. Document files can be uploaded by
specifying a file URL or base64 string. Either `file_url` or
`file_base64` must be present (not both). Valid file types are: .pdf,
.docx, .jpg, .png, .ppt, .xls, .pages, and .txt.
type: object
properties:
name:
description: Name of the file that will be uploaded.
type: string
file_url:
description: Publicly available URL of the file to be uploaded.
type: string
format: url
file_base64:
description: A RFC 4648 base64 string of the file to be uploaded.
type: string
format: byte
required:
- name
allow_decline_map:
description: >-
Whether to allow recipients the option to decline signing a document. If
multiple signers are involved in a document, any single recipient can
cancel the entire document signing process by declining to sign.
type: boolean
default: true
allow_reassign_map:
description: >-
In some cases a signer is not the right person to sign and may need to
reassign their signing responsibilities to another person. This feature
allows them to reassign the document to someone else.
type: boolean
default: true
api_application_id_map:
description: >-
Unique identifier for API Application settings to use. API Applications
are optional and mainly used when isolating OAuth apps or for more
control over embedded API settings
type: string
format: uuid
apply_sending_order_map:
description: >-
When set to `true` recipients will sign one at a time in the order of