{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a0f92106-25b4-4339-adb1-0ee3fa775276","name":"Documo API Documentation","description":"The Documo API is organized around REST. All calls to the Documo API should be made to [https://api.documo.com](https://api.documo.com). All responses are formatted in JSON.\n\n[Click here](https://next.docs.documo.com) for early access to additional endpoints (v2), still in beta.\n\n# Set Language of Code Snippets\n\nThe example code snippets shown on the side of each endpoint's description can be changed. At the very top of the documentation, select the dropdown titled \"Language\". The list contains many common programming languages and libraries to help get things started!\n\n# Enabling API Access\n\nTo begin using the Documo API, you will need to enable the API and generate an API key. This can be done in by logging into the web app and visiting Settings > API. [Visual instructions here.](https://help.documo.com/hc/en-us/articles/7789630698011-How-to-Enable-and-Retrieve-API-Keys)\n\n[Sign Up for API Key](https://www.mfax.io/pricing)\n\n[Visit Help Center](https://help.documo.com/hc/en-us)\n\n# API Key Access\n\nIn each section of this documentation, you will find which API key level of access is needed to use the corresponding endpoint.\n\nExamples:\n\n- Any level: `API Key Access: base | admin | print_driver`\n    \n- Admin only: `API Key Access: admin`\n    \n\n# Sandbox Environment (Beta)\n\nThe sandbox environment is a copy of our application, its purpose is to let customers test their integrations with our services. It doesn't send any real faxes and can't sign documents for officially, it's fail-safe to use as a testing environment.\n\nThe sandbox app can be accessed by URL [<code>https://app.sandbox.documo.com</code>](https://app.sandbox.documo.com) and API can be accessed by `https://api.sandbox.documo.com`.\n\nWe have some sandbox-specific tools for you to help you integrate. They are accessible by [Sandbox Tools](https://app.sandbox.documo.com/sandbox).\n\n[Read more about the Sandbox Environment here.](https://help.documo.com/hc/en-us/articles/7789817420571-Sandbox-Environment)\n\n# API Rate Limits\n\nRate limit is the number of API calls a user can make within a given time period per API token. Documo restricts API requests when you exceed the limit of 60 calls per minute. Fax history and reports endpoints are limited to 8 calls per minute.\n\nYou can check the current application rate limit usage in response headers:\n\n| Key | Type | Value | Description |\n| --- | --- | --- | --- |\n| X-RateLimit-Limit | number | 60 | Total limit |\n| X-RateLimit-Remaining | number | 59 | Remaining API calls |\n| X-RateLimit-Reset | number | 1614597318 | Timestamp when limit will reset |\n\nWhen the upper limit is breached, an HTTP 429 error response is returned for subsequent requests. As a result, no more requests are served until the limit resets (within one minute).\n\n# Errors\n\nThe Documo API uses the following error codes:\n\n| Error Code | Meaning |\n| --- | --- |\n| 400 | Invalid Input |\n| 401 | Unauthorized |\n| 403 | Forbidden |\n| 404 | Not Found |\n| 405 | Method Not Allowed |\n| 429 | Too Many Requests |\n| 500 | Internal Server Error |\n| 503 | Service Unavailable |\n\n# Result Codes\n\nThe result codes used in fax responses:\n\n| Result Code | Meaning |\n| --- | --- |\n| 0 | OK |\n| 1000 | Fax Pending |\n| 4000 | Fax Failed |\n| 5000 | Fax Resource Issue |\n| 5100 | Fax Request Blocked |\n| 5200 | Fax Rendering Issue |\n| 6000 | Fax Connect Failed |\n| 6100 | Fax Number Busy |\n| 6200 | Fax Machine Not Answering |\n| 6300 | Fax Detection Failed |\n| 6400 | Fax Pickup Failed |\n| 6500 | Fax Detection Failed |\n| 6600 | Fax Detection Timeout |\n| 6700 | Fax Number Blocked |\n| 6800 | Fax Negotiation Failed |\n| 7000 | Fax Training Failed |\n| 8000 | Fax Transmit Failed |\n| 9000 | Fax Failed |\n\n# Webhooks\n\nA great way to get familiar with the webhooks is trying them out. Webhooks will be send in both the [Sandbox Environment](https://docs.documo.com/#sandbox-environment-beta) and in the Production Environment.\n\nExample webhooks can be sent inside the application for each for type. If you would like to do some quick testing, [webhook.site](https://webhook.site) is a good option to capture webhook requests and view the data received.\n\nBelow is a list of the types of webhooks available.\n\n## Fax Inbound\n\n| **Field** | **Type** |\n| --- | --- |\n| messageId | Uuid |\n| deliveryId | String |\n| watermark | String |\n| messageNumber | String |\n| status | String |\n| pagesCount | Integer |\n| pagesComplete | Integer |\n| duration | Integer |\n| faxNumber | String |\n| faxCsid | String |\n| faxCallerId | String |\n| faxECM | Integer |\n| faxSpeed | Integer |\n| faxDetected | Boolean |\n| faxProtocol | Integer |\n| faxAttempt | Integer |\n| direction | String |\n| channelType | String |\n| deviceId | Uuid |\n| faxbridgeId | Uuid |\n| accountId | Uuid |\n| errorInfo | String (deprecated, use `resultInfo`) |\n| errorCode | String (deprecated, use `resultCode`) |\n| resultCode | String |\n| resultInfo | String |\n| isArchived | Boolean |\n| isFilePurged | Boolean |\n| country | String |\n| createdAt | Timestamp |\n| resolvedDate | Timestamp |\n| deletedAt | Timestamp |\n\n**Example Response**\n\n``` json\n{\n  \"messageId\": \"e0e72262-bf92-47ed-a78c-69547479cad8\",\n  \"deliveryId\": \"2220202171131453000\",\n  \"watermark\": \"2220202171154972000\",\n  \"messageNumber\": \"\",\n  \"status\": \"success\",\n  \"pagesCount\": 5,\n  \"pagesComplete\": 5,\n  \"duration\": 140000,\n  \"faxNumber\": \"+12349999999\",\n  \"faxCsid\": \"Fax CSID\",\n  \"faxCallerId\": \"1234567890\",\n  \"faxECM\": 256,\n  \"faxSpeed\": 33600,\n  \"faxDetected\": true,\n  \"faxProtocol\": 0,\n  \"faxAttempt\": 1,\n  \"direction\": \"inbound\",\n  \"channelType\": \"web\",\n  \"deviceId\": \"93fbdb1cb82d9b4bbf3d034b85c704e4037eb37b997636e2f19f337b3426622c\",\n  \"faxbridgeId\": null,\n  \"accountId\": \"f452a5c9-8867-4b41-a1a7-4979d81d68af\",\n  \"errorInfo\": \"\",\n  \"errorCode\": \"0\",\n  \"resultCode\": \"0\",\n  \"resultInfo\": \"\",\n  \"isArchived\": false,\n  \"isFilePurged\": false,\n  \"country\": \"US\",\n  \"createdAt\": \"2022-02-02T17:11:31.453Z\",\n  \"resolvedDate\": \"2022-02-02T17:11:54.972Z\",\n  \"deletedAt\": null\n}\n\n ```\n\n## Fax Outbound & Fax Outbound Extended\n\nFax outbound will send only once the fax has completed its entire lifespan. In most use cases this is sufficient. Fax outbound extended will send a request for each step along the lifespan (processing, transmitting, etc.) if more specific tracking is required.\n\n| **Field** | **Type** |\n| --- | --- |\n| messageId | Uuid |\n| deliveryId | String |\n| watermark | String |\n| messageNumber | String |\n| status | String |\n| pagesCount | Integer |\n| pagesComplete | Integer |\n| duration | Integer |\n| faxNumber | String |\n| faxCsid | String |\n| faxCallerId | String |\n| faxECM | Integer |\n| faxSpeed | Integer |\n| faxDetected | Boolean |\n| faxProtocol | Integer |\n| faxAttempt | Integer |\n| direction | String |\n| channelType | String |\n| deviceId | Uuid |\n| faxbridgeId | Uuid |\n| accountId | Uuid |\n| errorInfo | String (deprecated, use `resultInfo`) |\n| errorCode | String (deprecated, use `resultCode`) |\n| resultCode | String |\n| resultInfo | String |\n| isArchived | Boolean |\n| isFilePurged | Boolean |\n| country | String |\n| createdAt | Timestamp |\n| resolvedDate | Timestamp |\n| deletedAt | Timestamp |\n\n##### Example Response\n\n``` json\n{\n  \"messageId\": \"cc38a979-fedb-4f27-9ad1-4ba1375ec9f8\",\n  \"deliveryId\": \"2220202172805567000\",\n  \"watermark\": \"2220202172858200000\",\n  \"messageNumber\": \"\",\n  \"status\": \"success\",\n  \"pagesCount\": 3,\n  \"pagesComplete\": 3,\n  \"duration\": 140000,\n  \"faxNumber\": \"+12349999999\",\n  \"faxCsid\": \"Fax CSID\",\n  \"faxCallerId\": \"1234567890\",\n  \"faxECM\": 256,\n  \"faxSpeed\": 33600,\n  \"faxDetected\": true,\n  \"faxProtocol\": 0,\n  \"faxAttempt\": 1,\n  \"direction\": \"outbound\",\n  \"channelType\": \"web\",\n  \"deviceId\": \"41d24f48bae55c8336829be058417c86d78948ba5bdb6d0d8620a20252ea03c5\",\n  \"faxbridgeId\": null,\n  \"accountId\": \"1670f416-0db7-4bf5-9874-4f519e616e12\",\n  \"errorInfo\": \"\",\n  \"errorCode\": \"0\",\n  \"resultCode\": \"0\",\n  \"resultInfo\": \"\",\n  \"isArchived\": false,\n  \"isFilePurged\": false,\n  \"country\": \"US\",\n  \"createdAt\": \"2022-02-02T17:28:05.567Z\",\n  \"resolvedDate\": \"2022-02-02T17:28:58.200Z\",\n  \"deletedAt\": null\n}\n\n ```\n\n## User Create\n\n| **Field** | **Type** |\n| --- | --- |\n| uuid | Uuid |\n| accountId | Uuid |\n| ownedBy | String |\n| email | String |\n| emailSuppressed | Boolean |\n| firstName | String |\n| lastName | String |\n| userRole | String |\n| phone | String |\n| faxCsid | String |\n| faxCallerId | String |\n| faxDefaultCoverPage | Boolean |\n| pushNotifications | Boolean |\n| emailNotifySendOption | String |\n| emailNotifySendIncAttachment | Boolean |\n| emailNotifyReceiveOption | String |\n| emailNotifyReceiveIncAttachment | Boolean |\n| emailNotifyEmailToFaxQueued | Boolean |\n| emailToFaxCoverPageOption | Boolean |\n| isEmailConfirmed | Boolean |\n| avatar | String |\n| avatarPath | String |\n| jobPosition | String |\n| timezone | String |\n| driveFaxStoring | String |\n| driveFaxFolder | String |\n| signDefaultSignature | String |\n| signDefaultInitials | String |\n| signExpiresIn | Integer |\n| signFirstReminder | Boolean |\n| signFirstReminderIn | Integer |\n| signRepeatReminder | Boolean |\n| signRepeatReminderIn | Integer |\n| signExpirationWarning | Boolean |\n| fax | Boolean |\n| sign | Boolean |\n| drive | Boolean |\n| colorMode | String |\n| createdAt | Timestamp |\n| updatedAt | Timestamp |\n| isScim | Boolean |\n| deletedAt | Timestamp |\n\n**Example Response**\n\n``` json\n{\n  \"uuid\": \"9aaa60a6-8c89-4771-8eb8-ebb226bc9c57\",\n  \"accountId\": \"dc1b0cdb-c07b-4c7c-b9a8-ae4df7aa8278\",\n  \"ownedBy\": \"14291108-0199-457b-88a8-26383f6395e2\",\n  \"email\": \"Dasia25@hotmail.com\",\n  \"emailSuppressed\": false,\n  \"firstName\": \"Yasmine\",\n  \"lastName\": \"Renner\",\n  \"userRole\": \"user\",\n  \"phone\": \"2349999999\",\n  \"faxCsid\": null,\n  \"faxCallerId\": \"1234567890\",\n  \"faxDefaultCoverPage\": null,\n  \"pushNotifications\": true,\n  \"emailNotifySendOption\": \"all\",\n  \"emailNotifySendIncAttachment\": true,\n  \"emailNotifyReceiveOption\": \"all\",\n  \"emailNotifyReceiveIncAttachment\": true,\n  \"emailNotifyEmailToFaxQueued\": false,\n  \"emailToFaxCoverPageOption\": true,\n  \"isEmailConfirmed\": true,\n  \"avatar\": null,\n  \"avatarPath\": null,\n  \"jobPosition\": null,\n  \"timezone\": \"inherit\",\n  \"driveFaxStoring\": false,\n  \"driveFaxFolder\": null,\n  \"signDefaultSignature\": null,\n  \"signDefaultInitials\": null,\n  \"signExpiresIn\": 60,\n  \"signFirstReminder\": true,\n  \"signFirstReminderIn\": 14,\n  \"signRepeatReminder\": true,\n  \"signRepeatReminderIn\": 7,\n  \"signExpirationWarning\": true,\n  \"fax\": true,\n  \"sign\": true,\n  \"drive\": true,\n  \"colorMode\": \"auto\",\n  \"createdAt\": \"2022-02-02T17:32:19.818Z\",\n  \"updatedAt\": \"2022-02-02T17:32:19.818Z\",\n  \"isScim\": null,\n  \"deletedAt\": null\n}\n\n ```\n\n## User Delete\n\n| **Field** | **Type** |\n| --- | --- |\n| uuid | Uuid |\n| accountId | Uuid |\n| ownedBy | String |\n| email | String |\n| emailSuppressed | Boolean |\n| firstName | String |\n| lastName | String |\n| userRole | String |\n| phone | String |\n| faxCsid | String |\n| faxCallerId | String |\n| faxDefaultCoverPage | Boolean |\n| pushNotifications | Boolean |\n| emailNotifySendOption | String |\n| emailNotifySendIncAttachment | Boolean |\n| emailNotifyReceiveOption | String |\n| emailNotifyReceiveIncAttachment | Boolean |\n| emailNotifyEmailToFaxQueued | Boolean |\n| emailToFaxCoverPageOption | Boolean |\n| isEmailConfirmed | Boolean |\n| avatar | String |\n| avatarPath | String |\n| jobPosition | String |\n| timezone | String |\n| driveFaxStoring | String |\n| driveFaxFolder | String |\n| signDefaultSignature | String |\n| signDefaultInitials | String |\n| signExpiresIn | Integer |\n| signFirstReminder | Boolean |\n| signFirstReminderIn | Integer |\n| signRepeatReminder | Boolean |\n| signRepeatReminderIn | Integer |\n| signExpirationWarning | Boolean |\n| fax | Boolean |\n| sign | Boolean |\n| drive | Boolean |\n| colorMode | String |\n| createdAt | Timestamp |\n| updatedAt | Timestamp |\n| isScim | Boolean |\n| deletedAt | Timestamp |\n\n**Example Response**\n\n``` json\n{\n  \"uuid\": \"8f8620fd-2e93-4df8-b9dc-f6c4e991b09c\",\n  \"accountId\": \"bad04f30-fa7b-43e2-9747-4755099051c5\",\n  \"ownedBy\": \"a2b611c8-f411-4df0-ba53-0eb5efbf7957\",\n  \"email\": \"Laurine93@yahoo.com\",\n  \"emailSuppressed\": false,\n  \"firstName\": \"Rollin\",\n  \"lastName\": \"Koch\",\n  \"userRole\": \"user\",\n  \"phone\": \"2349999999\",\n  \"faxCsid\": null,\n  \"faxCallerId\": \"1234567890\",\n  \"faxDefaultCoverPage\": null,\n  \"pushNotifications\": true,\n  \"emailNotifySendOption\": \"all\",\n  \"emailNotifySendIncAttachment\": true,\n  \"emailNotifyReceiveOption\": \"all\",\n  \"emailNotifyReceiveIncAttachment\": true,\n  \"emailNotifyEmailToFaxQueued\": false,\n  \"emailToFaxCoverPageOption\": true,\n  \"isEmailConfirmed\": true,\n  \"avatar\": null,\n  \"avatarPath\": null,\n  \"jobPosition\": null,\n  \"timezone\": \"inherit\",\n  \"driveFaxStoring\": false,\n  \"driveFaxFolder\": null,\n  \"signDefaultSignature\": null,\n  \"signDefaultInitials\": null,\n  \"signExpiresIn\": 60,\n  \"signFirstReminder\": true,\n  \"signFirstReminderIn\": 14,\n  \"signRepeatReminder\": true,\n  \"signRepeatReminderIn\": 7,\n  \"signExpirationWarning\": true,\n  \"fax\": true,\n  \"sign\": true,\n  \"drive\": true,\n  \"colorMode\": \"auto\",\n  \"createdAt\": \"2022-02-02T17:44:18.129Z\",\n  \"updatedAt\": \"2022-02-02T17:44:18.129Z\",\n  \"isScim\": null,\n  \"deletedAt\": null\n}\n\n ```\n\n## Number Add\n\n| **Field** | **Type** |\n| --- | --- |\n| uuid | Uuid |\n| number | String |\n| numberE164 | String |\n| pendingUntil | Timestamp |\n| pendingPort | Boolean |\n| ownedBy | Uuid |\n| managedBy | Uuid |\n| storage | String |\n| isLocal | Boolean |\n| portReplacementNumberId | String |\n\n**Example Response**\n\n``` json\n{\n  \"uuid\": \"115acc75-7387-437f-bf80-6408b26a7a17\",\n  \"number\": \"2349999999\",\n  \"numberE164\": \"+12349999999\",\n  \"pendingUntil\": \"2022-02-02T17:49:25.787Z\",\n  \"pendingPort\": false,\n  \"ownedBy\": \"10391427-f882-46e6-91e7-536a737be46c\",\n  \"managedBy\": \"fa9b630e-1f43-4ee1-9f88-39920768c478\",\n  \"storage\": null,\n  \"isLocal\": true,\n  \"portReplaceNumberId\": null\n}\n\n ```\n\n## Number Release\n\n| **Field** | **Type** |\n| --- | --- |\n| uuid | Uuid |\n| number | String |\n| numberE164 | String |\n| pendingUntil | Timestamp |\n| pendingPort | Boolean |\n| ownedBy | Uuid |\n| managedBy | Uuid |\n| storage | String |\n| isLocal | Boolean |\n| portReplacementNumberId | String |\n\n**Example Response**\n\n``` json\n{\n  \"uuid\": \"9c294a08-3e36-4dc7-9f68-3f4308cb5497\",\n  \"number\": \"2349999999\",\n  \"numberE164\": \"+12349999999\",\n  \"pendingUntil\": \"2022-02-02T17:51:34.724Z\",\n  \"pendingPort\": false,\n  \"ownedBy\": \"654ab973-6068-48a3-bfa3-b9d68eb6526c\",\n  \"managedBy\": \"8511924a-524c-4e89-a94d-cb27d3946ed5\",\n  \"storage\": null,\n  \"isLocal\": true,\n  \"portReplaceNumberId\": null\n}\n\n ```\n\n## Number Ported\n\n| **Field** | **Type** |\n| --- | --- |\n| uuid | Uuid |\n| number | String |\n| numberE164 | String |\n| pendingUntil | Timestamp |\n| pendingPort | Boolean |\n| ownedBy | Uuid |\n| managedBy | Uuid |\n| storage | String |\n| isLocal | Boolean |\n| portReplacementNumberId | String |\n\n**Example Response**\n\n``` json\n{\n  \"uuid\": \"48fad9bf-b95c-47ea-97fa-b4620f4fac3d\",\n  \"number\": \"2349999999\",\n  \"numberE164\": \"+12349999999\",\n  \"pendingUntil\": \"2022-02-02T17:52:29.322Z\",\n  \"pendingPort\": false,\n  \"ownedBy\": \"5cd8603b-9f10-44eb-b252-4c1e716cafe8\",\n  \"managedBy\": \"71149e27-8be1-477b-b0ae-07367fa7e603\",\n  \"storage\": null,\n  \"isLocal\": true,\n  \"portReplaceNumberId\": null\n}\n\n ```\n\n## Document Completed\n\n| **Field** | **Type** |\n| --- | --- |\n| status | String |\n| statusCapitalized | String |\n| daysLeft | Integer |\n| uuid | Uuid |\n| title | String |\n| accountId | Uuid |\n| draft | Boolean |\n| declined | Boolean |\n| viewed | Boolean |\n| signMode | String |\n| order | Boolean |\n| isPublic | Boolean |\n| sharedWithAccount | Boolean |\n| isApprovedOrderEnabled | Boolean |\n| approvedStatus | String |\n| currentSigner | Uuid |\n| type | String |\n| emailMessage | String |\n| declineReasonRequired | Boolean |\n| hash | String |\n| fileId | Uuid |\n| signedFileId | Uuid |\n| chatroomId | Uuid |\n| expiresIn | Integer |\n| firstReminder | Boolean |\n| firstReminderIn | Integer |\n| repeatReminder | Boolean |\n| repeatReminderIn | Integer |\n| expirationWarning | Boolean |\n| confirmationPage | Boolean |\n| auditTrail | Boolean |\n| industryId | Uuid |\n| formId | Uuid |\n| sentAt | Timestamp |\n| completedAt | Timestamp |\n| createdAt | Timestamp |\n| updatedAt | Timestamp |\n| deletedAt | Timestamp |\n\n``` json\n{\n  \"status\": \"completed\",\n  \"statusCapitalized\": \"Completed\",\n  \"daysLeft\": null,\n  \"uuid\": \"23b3b0f7-2b5b-465e-a888-95c5615c4e41\",\n  \"title\": \"test-document\",\n  \"accountId\": \"27a69b7e-0219-46c4-9217-992847c1e90b\",\n  \"draft\": false,\n  \"declined\": null,\n  \"viewed\": true,\n  \"signMode\": \"all\",\n  \"order\": false,\n  \"isPublic\": false,\n  \"sharedWithAccount\": false,\n  \"isApproveOrderEnabled\": false,\n  \"approveStatus\": \"not_needed\",\n  \"currentSigner\": null,\n  \"type\": \"document\",\n  \"emailMessage\": null,\n  \"declineReasonRequired\": false,\n  \"hash\": \"8e37f57d5d4cc817490af46048d2609df4103add33a816cf4c1d80e5fd857fdc\",\n  \"fileId\": \"f1758c06-6d64-4c32-b482-47325fa70f0a\",\n  \"signedFileId\": \"b482ba53-e94a-4d1a-bb4a-ffb6d6649964\",\n  \"chatroomId\": \"06cd9867-0923-44ce-ab50-aa3698627c7e\",\n  \"expiresIn\": 60,\n  \"firstReminder\": true,\n  \"firstReminderIn\": 14,\n  \"repeatReminder\": true,\n  \"repeatReminderIn\": 7,\n  \"expirationWarning\": true,\n  \"confirmationPage\": true,\n  \"auditTrail\": false,\n  \"industryId\": null,\n  \"formId\": null,\n  \"sentAt\": \"2022-02-02T17:52:57.860Z\",\n  \"completedAt\": \"2022-02-02T17:52:57.860Z\",\n  \"createdAt\": \"2022-02-02T17:52:57.860Z\",\n  \"updatedAt\": \"2022-02-02T17:52:57.860Z\",\n  \"deletedAt\": null\n}\n\n ```\n\n## Document Failed\n\n| **Field** | **Type** |\n| --- | --- |\n| status | String |\n| statusCapitalized | String |\n| daysLeft | Integer |\n| uuid | Uuid |\n| title | String |\n| accountId | Uuid |\n| draft | Boolean |\n| declined | Boolean |\n| viewed | Boolean |\n| signMode | String |\n| order | Boolean |\n| isPublic | Boolean |\n| sharedWithAccount | Boolean |\n| isApprovedOrderEnabled | Boolean |\n| approvedStatus | String |\n| currentSigner | Uuid |\n| type | String |\n| emailMessage | String |\n| declineReasonRequired | Boolean |\n| hash | String |\n| fileId | Uuid |\n| signedFileId | Uuid |\n| chatroomId | Uuid |\n| expiresIn | Integer |\n| firstReminder | Boolean |\n| firstReminderIn | Integer |\n| repeatReminder | Boolean |\n| repeatReminderIn | Integer |\n| expirationWarning | Boolean |\n| confirmationPage | Boolean |\n| auditTrail | Boolean |\n| industryId | Uuid |\n| formId | Uuid |\n| sentAt | Timestamp |\n| completedAt | Timestamp |\n| createdAt | Timestamp |\n| updatedAt | Timestamp |\n| deletedAt | Timestamp |\n\n``` json\n{\n  \"status\": \"failed\",\n  \"statusCapitalized\": \"Failed\",\n  \"daysLeft\": null,\n  \"uuid\": \"a8dab87c-9c2a-4a4a-84b1-a22cd752d593\",\n  \"title\": \"test-document\",\n  \"accountId\": \"6827eb27-f1de-4f82-abd3-fc4348e2af6d\",\n  \"draft\": false,\n  \"declined\": null,\n  \"viewed\": true,\n  \"signMode\": \"all\",\n  \"order\": false,\n  \"isPublic\": false,\n  \"sharedWithAccount\": false,\n  \"isApproveOrderEnabled\": false,\n  \"approveStatus\": \"not_needed\",\n  \"currentSigner\": null,\n  \"type\": \"document\",\n  \"emailMessage\": null,\n  \"declineReasonRequired\": false,\n  \"hash\": \"8e37f57d5d4cc817490af46048d2609df4103add33a816cf4c1d80e5fd857fdc\",\n  \"fileId\": \"4100b42d-8994-4e3f-ac60-a88cc97d4389\",\n  \"signedFileId\": \"9dd14747-2079-4ac2-a2e7-2127b8ca7a3e\",\n  \"chatroomId\": \"298d48a5-54af-45fe-b457-5bad4f944860\",\n  \"expiresIn\": 60,\n  \"firstReminder\": true,\n  \"firstReminderIn\": 14,\n  \"repeatReminder\": true,\n  \"repeatReminderIn\": 7,\n  \"expirationWarning\": true,\n  \"confirmationPage\": true,\n  \"auditTrail\": false,\n  \"industryId\": null,\n  \"formId\": null,\n  \"sentAt\": \"2022-02-02T18:01:32.799Z\",\n  \"completedAt\": \"2022-02-02T18:01:32.799Z\",\n  \"createdAt\": \"2022-02-02T18:01:32.799Z\",\n  \"updatedAt\": \"2022-02-02T18:01:32.799Z\",\n  \"deletedAt\": null\n}\n\n ```\n\n## User's Session Initiated and User's Session Terminated\n\nA session initiated webhook is triggered when user signs in, indicating the beginning of their session. Session terminated webhook is triggered when user signs out.\n\n| **Field** | **Type** |\n| --- | --- |\n| userId | Uuid |\n| email | string |\n| sessionId | Uuid |\n\n``` json\n{\n  \"userId\": \"a8dab87c-9c2a-4a4a-84b1-a22cd752d593\",\n  \"email\": \"email@example.com\",\n  \"sessionId\": \"6827eb27-f1de-4f82-abd3-fc4348e2af6d\"\n}\n\n ```\n\nYou may also find useful How To’s and tips by visiting our [Help Center](https://help.documo.com/).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14677030","collectionId":"a0f92106-25b4-4339-adb1-0ee3fa775276","publishedId":"TzRa5ia9","public":true,"publicUrl":"https://docs.documo.com","privateUrl":"https://go.postman.co/documentation/14677030-a0f92106-25b4-4339-adb1-0ee3fa775276","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"45b3ff"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/eb4a2ed3-7d75-4398-85e8-946101ce3bae/YXZhdGFyX2RvY3Vtb19pY29uXzM2MC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/eb4a2ed3-7d75-4398-85e8-946101ce3bae/YXZhdGFyX2RvY3Vtb19pY29uXzM2MC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"45b3ff"}}]}},"version":"8.10.1","publishDate":"2025-01-03T17:03:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/eb4a2ed3-7d75-4398-85e8-946101ce3bae/YXZhdGFyX2RvY3Vtb19pY29uXzM2MC5wbmc=","logoDark":"https://content.pstmn.io/eb4a2ed3-7d75-4398-85e8-946101ce3bae/YXZhdGFyX2RvY3Vtb19pY29uXzM2MC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/054cd0081a86ee79ca7e74a60b5041a3ad5ea00bf744d022d1aba432aed4e730","favicon":"https://res.cloudinary.com/postman/image/upload/v1735931371/team/13c1dae1f303d6e74e0a6bd44d6387d8.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.documo.com/view/metadata/TzRa5ia9"}