Skip to content

Commit 8be42be

Browse files
DineshtnjrDineshtnjr
committed
ApiDocumentation2.0-done
1 parent b661bad commit 8be42be

2 files changed

Lines changed: 73 additions & 83 deletions

File tree

‎docs/API-Documentation/E-Sign.md‎

Lines changed: 59 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -374,16 +374,16 @@ json
374374
"parties": [
375375
{
376376
"id": "1",
377-
"name": "John Doe",
378-
"email": "john.doe@example.com",
377+
"name": "User One",
378+
"email": "user.one@example.test",
379379
"color": "hsl(196, 100%, 90%)",
380380
"status": {
381381
"sent": [
382382
{
383383
"isSent": true,
384384
"dateTime": "2025-12-12T16:00:50.797238+00:00",
385-
"party_name": "John Doe",
386-
"party_email": "john.doe@example.com",
385+
"party_name": "User One",
386+
"party_email": "user.one@example.test",
387387
"ip": "34.201.55.91",
388388
"browser": "Chrome",
389389
"os": "Windows 11",
@@ -401,8 +401,8 @@ json
401401
{
402402
"isOpened": true,
403403
"dateTime": "2025-12-12T16:11:04.313365+00:00",
404-
"party_name": "John Doe",
405-
"party_email": "john.doe@example.com",
404+
"party_name": "User One",
405+
"party_email": "user.one@example.test",
406406
"ip": "34.201.45.91",
407407
"browser": "Chrome",
408408
"os": "Windows 11",
@@ -420,8 +420,8 @@ json
420420
{
421421
"isSigned": true,
422422
"dateTime": "2025-12-12T16:12:49.689499+00:00",
423-
"party_name": "John Doe",
424-
"party_email": "john.doe@example.com",
423+
"party_name": "User One",
424+
"party_email": "user.one@example.test",
425425
"ip": "34.201.45.91",
426426
"browser": "Chrome",
427427
"os": "Windows 11",
@@ -448,17 +448,17 @@ json
448448
"parties": [
449449
{
450450
"id": "1",
451-
"name": "Alex Brown",
452-
"email": "alex.brown@example.com",
451+
"name": "User Two",
452+
"email": "user.two@example.test",
453453
"color": null,
454454
"status": {
455455
"cancelled": [
456456
{
457457
"isCancelled": true,
458458
"reason": "Invalid document format",
459459
"dateTime": "2025-12-31T21:48:44.275476+00:00",
460-
"party_name": "Alex Brown",
461-
"party_email": "alex.brown@example.com",
460+
"party_name": "User Two",
461+
"party_email": "user.two@example.test",
462462
"ip": "18.211.90.44",
463463
"browser": "Chrome",
464464
"os": "Windows 11",
@@ -476,49 +476,49 @@ json
476476
}
477477
]
478478
},
479+
{
480+
"document_id": "92c79f09-76c5-4cf8-bab6-9b98721ncefc",
481+
"tracking_id": "ac532311-6c71-4f65-aea6-a6chnj77faefa",
482+
"validity_date": "2026-12-12T18:29:59.000Z",
483+
"status": "scheduled",
484+
"datetime": "2026-01-06T13:42:49.000600+00:00",
485+
"parties": [
479486
{
480-
"document_id": "92c79f09-76c5-4cf8-bab6-9b98721ncefc",
481-
"tracking_id": "ac532311-6c71-4f65-aea6-a6chnj77faefa",
482-
"validity_date": "2026-12-12T18:29:59.000Z",
483-
"status": "scheduled",
484-
"datetime": "2026-01-06T13:42:49.000600+00:00",
485-
"parties": [
486-
{
487-
"id": "1",
488-
"name": "gowtham 1",
489-
"email": "govisgr8@gmail.com",
490-
"color": "hsl(196, 100%, 90%)",
491-
"status": {
492-
"scheduled": [
493-
{
494-
"isScheduled": true,
495-
"dateTime": "2026-01-06T13:42:49.000600+00:00",
496-
"party_name": "gowtham 1",
497-
"party_email": "govisgr8@gmail.com",
498-
"ip": "34.228.4.221",
499-
"browser": "HeadlessChrome",
500-
"os": "Linux ",
501-
"device": "PC/Laptop",
502-
"location": {
503-
"city": "Ashburn",
504-
"region": "Virginia",
505-
"country": "US",
506-
"timestamp": "2026-01-06T13:42:48.584Z",
507-
"timezone": "America/New_York"
508-
}
509-
}
510-
]
511-
}
512-
},
513-
{
514-
"id": "2",
515-
"name": "gowtham 2",
516-
"email": "govisgr4@gmail.com",
517-
"color": "hsl(80, 70%, 90%)",
518-
"status": {}
487+
"id": "1",
488+
"name": "Signer One",
489+
"email": "signer.one@example.test",
490+
"color": "hsl(196, 100%, 90%)",
491+
"status": {
492+
"scheduled": [
493+
{
494+
"isScheduled": true,
495+
"dateTime": "2026-01-06T13:42:49.000600+00:00",
496+
"party_name": "Signer One",
497+
"party_email": "signer.one@example.test",
498+
"ip": "34.228.4.221",
499+
"browser": "HeadlessChrome",
500+
"os": "Linux",
501+
"device": "PC/Laptop",
502+
"location": {
503+
"city": "Ashburn",
504+
"region": "Virginia",
505+
"country": "US",
506+
"timestamp": "2026-01-06T13:42:48.584Z",
507+
"timezone": "America/New_York"
519508
}
509+
}
520510
]
511+
}
521512
},
513+
{
514+
"id": "2",
515+
"name": "Signer Two",
516+
"email": "signer.two@example.test",
517+
"color": "hsl(80, 70%, 90%)",
518+
"status": {}
519+
}
520+
]
521+
},
522522
{
523523
"document_id": "021fc34b-b267-43ba-a7af-455286ebe90b",
524524
"tracking_id": "0e8aa699-9114-4cbb-a479-m50cf693f988",
@@ -528,8 +528,8 @@ json
528528
"parties": [
529529
{
530530
"id": "1",
531-
"name": "Emily Clark",
532-
"email": "emily.clark@example.com",
531+
"name": "User Three",
532+
"email": "user.three@example.test",
533533
"color": "hsl(196, 100%, 90%)",
534534
"status": {}
535535
}
@@ -544,16 +544,16 @@ json
544544
"parties": [
545545
{
546546
"id": "1",
547-
"name": "Michael Lee",
548-
"email": "michael.lee@example.com",
547+
"name": "User Four",
548+
"email": "user.four@example.test",
549549
"color": "#ccf1ffff",
550550
"status": {
551551
"shared": [
552552
{
553553
"isShared": true,
554554
"dateTime": "2026-01-06T13:15:29.208286+00:00",
555-
"party_name": "Michael Lee",
556-
"party_email": "michael.lee@example.com",
555+
"party_name": "User Four",
556+
"party_email": "user.four@example.test",
557557
"ip": "44.193.15.98",
558558
"browser": "Chrome",
559559
"os": "Linux",
@@ -574,6 +574,7 @@ json
574574
]
575575
}
576576
577+
577578
````
578579

579580
### **Responses**
@@ -907,14 +908,7 @@ This API returns the **signed document** in **PDF format.**
907908
<p>
908909
<a href="files/Sample Two-Party Agreement-Authorized.pdf" target="_blank"
909910
style="display:inline-block; background-color:#007bff; color:white; padding:10px 20px; border-radius:6px; text-decoration:none;">
910-
📄 ⬇️Download Sample PDF
911-
</a>
912-
</p>
913-
914-
<p>
915-
<a href="files/Sample Two-Party Agreement-Authorized.pdf" target="_blank"
916-
style="display:inline-block; background-color:#1E90FF; color:white; padding:10px 20px; border-radius:6px; text-decoration:none;">
917-
⬇️Download Sample PDF
911+
📄 Download Sample PDF
918912
</a>
919913
</p>
920914

‎docs/_sidebar.md‎

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Getting started](README.md)
1+
 [Getting started](README.md)
22

33
---
44

@@ -10,6 +10,19 @@
1010
- [How to decline eSign document?](E_Sign\decline-esign-document.md)
1111
- [How to resend eSign document?](E_Sign\resend-esign-document.md)
1212

13+
- **Wet Signature**
14+
- [Wet-Sign in Doculan](Wet-Signature/WetSign.md)
15+
16+
<!-- docs\Wet-Signature\WetSign.md -->
17+
18+
19+
20+
- **Video Enabled Esign**
21+
- [E-Sign Record in Doculan](Video_Enabled-Esign/VideoEsign.md)
22+
23+
<!-- docs\Video_Enabled-Esign\VideoEsign.md -->
24+
25+
1326
---
1427

1528
- **E-Signature Template**
@@ -26,21 +39,6 @@
2639
- [How to cancel shared document?](E_Sign\cancel-shared-document.md)
2740

2841
---
29-
30-
- **Wet Signature**
31-
- [Wet-Sign in Doculan](Wet-Signature/WetSign.md)
32-
33-
<!-- docs\Wet-Signature\WetSign.md -->
34-
35-
---
36-
37-
- **Video Enabled Esign**
38-
- [E-Sign Record in Doculan](Video_Enabled-Esign/VideoEsign.md)
39-
40-
<!-- docs\Video_Enabled-Esign\VideoEsign.md -->
41-
42-
---
43-
4442
- **Form Management**
4543
- [How to Create and Send Forms?](Forms/Form_Create.md)
4644
- [How do view Submitted Form with attachments?](Forms/Form_Document_Storage.md)
@@ -49,8 +47,6 @@
4947
- [How to Delete Form?](Forms/Form-Delete.md)
5048
- [How to Resend Form?](Forms/Form_Resend.md)
5149

52-
---
53-
5450
- **Embedded Esign**
5551
- [E-Sign Embedded in Doculan](Embedded-Esign/EmbdedEsign.md)
5652

0 commit comments

Comments
 (0)