The Documo API is organized around REST. All calls to the Documo API should be made to https://api.documo.com. All responses are formatted in JSON.
\nThese endpoints are in beta, therefore they are subject to change.
\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!
\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.
\n\n\n\nIn each section of this documentation, you will find which API key level of access is needed to use the corresponding endpoint.
\nExamples:
\nAny level: API Key Access: base | admin | print_driver
Admin only: API Key Access: admin
The 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.
\nThe sandbox app can be accessed by URL https://app.sandbox.documo.com and API can be accessed by https://api.sandbox.documo.com.
We have some sandbox-specific tools for you to help you integrate. They are accessible by Sandbox Tools.
\nRead more about the Sandbox Environment here.
\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.
\nYou can check the current application rate limit usage in response headers:
\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).
\nThe Documo API uses the following error codes:
\nA great way to get familiar with the webhooks is trying them out. Webhooks will be send in both the Sandbox Environment and in the Production Environment.
\nExample webhooks can be sent inside the application for each for type. If you would like to do some quick testing, webhook.site is a good option to capture webhook requests and view the data received.
\nBelow is a list of the types of webhooks available.
\nExample Response
\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\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 \"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\nExample Response
\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\nExample Response
\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\nExample Response
\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\nExample Response
\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\nExample Response
\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 \"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 \"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\nocr.v1.document.complete) (beta){\n \"id\": \"00000000-25f4-4458-872f-0af814c7ff7a\",\n \"accountId\": \"00000000-d9a0-493f-a3aa-0cb1114eea0c\",\n \"wsDocId\": \"00000000-0bc5-40b5-804e-2fe50acd8d71\",\n \"status\": \"success\",\n \"pagesCount\": 1,\n \"createdAt\": \"2035-05-15T15:02:35.736Z\",\n \"completedAt\": \"2035-05-15T15:02:42.661Z\",\n \"ocrData\": {\n \"text\": \"OCR text here\"\n }\n}\n\nidp.v1.document-field-value.assigned) (beta){\n \"accountId\": \"00000000-d9a0-493f-a3aa-0cb1114eea0c\",\n \"workspaceId\": \"00000000-d9a0-493f-a3aa-0cb1114eea0f\",\n \"documentId\": \"00000000-d9a0-493f-a3aa-0cb1114eea01\",\n \"user\": {\n \"id\": \"abe1bfa6-091c-4b8d-881e-b1f9ae5026d8\",\n \"email\": \"qa0@documo-test.com\"\n },\n \"assignments\": [\n {\n \"field\": {\n \"id\": \"b85f5f5a-000f-4586-947c-a1ed197a4ca7\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"field\": {\n \"id\": \"27013664-6842-4905-abbe-bf4cbc8e1769\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n },\n {\n \"field\": {\n \"id\": \"555e410f-7404-4a34-8951-3db2c713264d\",\n \"name\": \"DOB\"\n },\n \"value\": \"2000-04-04T12:00:00.297Z\"\n },\n {\n \"field\": {\n \"id\": \"fa9f7c47-da2e-4acc-8978-257e9ed28fe1\",\n \"name\": \"Middle Name\"\n },\n \"value\": \"null\"\n }\n ]\n}\n\nidp.v1.document-type.updated) (beta){\n \"workspace\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"name\": \"Workspace one\"\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\"\n },\n \"document\": {\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"DK_upload1\",\n \"sourceType\": \"upload\" | \"fax\" | \"email\",\n \"sourceId\": \"33333333-3333-3333-3333-333333333333\",\n \"from\": null,\n \"to\": null,\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"addedAt\": \"1970-01-01 00:00:00.000000\",\n \"pagesCount\": 1,\n \"typeId\": \"44444444-4444-4444-4444-444444444444\",\n \"statusId\": \"55555555-5555-5555-5555-555555555555\",\n \"isUploading\": false\n },\n \"type\": {\n \"id\": \"66666666-6666-6666-6666-666666666666\",\n \"name\": \"admission form\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"locked\": true\n },\n \"user\": {\n \"uuid\": \"77777777-7777-7777-7777-777777777777\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"email\": \"test@test.com\",\n {...}\n }\n}\n\nidp.v1.split-detection.completed) (beta)Fires when a document completes a successful split detection analysis. Use the Request Document Split Detection endpoint to initiate analysis.
\n{\n \"accountId\": \"f452a5c9-8867-4b41-a1a7-4979d81d68af\",\n \"workspaceId\": \"d1077489-5ea1-4db1-9760-853f175e8288\",\n \"documentId\": \"e0e72262-bf92-47ed-a78c-69547479cad8\",\n \"segments\": [\n {\n \"pages\": [1, 2, 3],\n \"confidence\": 0.95\n },\n {\n \"pages\": [4, 5],\n \"confidence\": 0.88\n }\n ],\n \"analysisId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"modelVersion\": \"1.0.0\"\n}\n\nYou may also find useful How To’s and tips by visiting our Help Center.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Beta","slug":"beta"},{"content":"Set Language of Code Snippets","slug":"set-language-of-code-snippets"},{"content":"Enabling API Access","slug":"enabling-api-access"},{"content":"API Key Access","slug":"api-key-access"},{"content":"Sandbox Environment (Beta)","slug":"sandbox-environment-beta"},{"content":"API Rate Limits","slug":"api-rate-limits"},{"content":"Errors","slug":"errors"},{"content":"Webhooks","slug":"webhooks"}],"owner":"26679664","collectionId":"decb20da-6e5d-41d6-970f-0a5c737a0768","publishedId":"2s9Xy6oofd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"45b3ff"},"publishDate":"2025-01-03T17:59:23.000Z"},"item":[{"name":"Reports","item":[{"name":"Account Reports","item":[{"name":"Usage Total","id":"df9f6dcd-a970-4233-ad4e-e385d0af0580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"includeDescendants","value":"true","description":"boolean, default true
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.documo.com/fax/v2/reports/usage/:accountId/total","description":"This endpoint makes an HTTP GET request to retrieve the total fax usage report for a specific account or its descendants. The request should include the account ID, start date, end date, and an optional parameter to include descendants in the report.
\naccountId (string, required): The ID of the account for which the total amount of usage is to be retrieved.includeDescendants: A flag to indicate whether the subaccounts of the specified account should be included in the result.dateStart: The start date for the usage report.dateEnd: The end date for the usage reporttype: Filter usage typecountry: Filter by countryoutput: json or csv outputdirection: Filter usage by direction, inbound or outboundThe response will be a JSON object representing the total fax usage report for the specified account or its descendants. To document the response as a JSON schema, the structure of the response body should be captured, including the data types and any nested objects or arrays present in the response.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Start date as ISO 8601 string
\n","type":"text/plain"},"key":"dateStart","value":""},{"disabled":true,"description":{"content":"String | Required | End date as ISO 8601 string
\n","type":"text/plain"},"key":"dateEnd","value":""},{"disabled":true,"description":{"content":"inbound | outbound
\n","type":"text/plain"},"key":"direction","value":null},{"disabled":true,"description":{"content":"outbound | inbound | fmc_inbound | fmc_outbound | forwarded
\n","type":"text/plain"},"key":"type","value":"inbound"},{"disabled":true,"description":{"content":"String | 2 letter country code | ISO 3166-1 alpha-2
\n","type":"text/plain"},"key":"country","value":"US"},{"disabled":true,"description":{"content":"json | csv
\n","type":"text/plain"},"key":"output","value":null},{"disabled":true,"description":{"content":"Boolean | Include subaccounts to report
\n","type":"text/plain"},"key":"includeDescendants","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"baf0d1c8-3c43-4f7d-a528-d7dcec69deba","name":"fax/v2/reports/usage/:accountId/total","originalRequest":{"method":"GET","header":[{"key":"includeDescendants","value":"true","description":"boolean, default true"}],"url":{"raw":"https://api.documo.com/fax/v2/reports/usage/:accountId/total?dateStart=2023-05-01T00:00:00.000Z&dateEnd=2023-06-01T00:00:00.000Z&includeDescendants=true","host":["https://api.documo.com"],"path":["fax","v2","reports","usage",":accountId","total"],"query":[{"key":"dateStart","value":"2023-05-01T00:00:00.000Z"},{"key":"dateEnd","value":"2023-06-01T00:00:00.000Z"},{"key":"includeDescendants","value":"true"},{"key":"type","value":"inbound","description":"inbound | forwarded | outbound | fb_outbound","disabled":true},{"key":"country","value":"US","disabled":true}],"variable":[{"key":"accountId","value":"360830a9-f3a1-4bc6-8743-19d992d41548","description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\",\n \"total\": 180,\n \"pages\": 675,\n \"pagesComplete\": 641,\n \"duration\": 8138321\n}"}],"_postman_id":"df9f6dcd-a970-4233-ad4e-e385d0af0580"},{"name":"Users Total","id":"f8825ef7-e4a4-4469-ba4d-6ecb30883691","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/reports/users/:accountId/total?includeDescendants=true","description":"This endpoint makes an HTTP GET request to retrieve the total number of users for a specified account ID including its descendants
\naccountId (string, required): The ID of the account for which the total number of users is to be retrieved.includeDescendants (boolean, required): A flag to indicate whether the subaccounts of the specified account should be included in the result.Upon a successful request, the response will include the total count of users for the specified account and its descendants.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Boolean | Default: true
\n","type":"text/plain"},"key":"includeDescendants","value":"true"}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"64eaed1f-4e6c-4dc5-8e8e-aa49f63379db","name":"Total User Account Report","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/identity/v2/reports/users/:accountId/total?includeDescendants=true","host":["https://api.documo.com"],"path":["identity","v2","reports","users",":accountId","total"],"query":[{"key":"includeDescendants","value":"true","description":"Boolean | Default: true "}],"variable":[{"key":"accountId","value":null,"description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea1p\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\",\n \"total\": \"1000\",\n \"roleOwner\": \"300\",\n \"roleAdmin\": \"200\",\n \"roleSupport\": \"10\",\n \"roleUser\": \"1234\"\n}\n"}],"_postman_id":"f8825ef7-e4a4-4469-ba4d-6ecb30883691"},{"name":"Numbers Total","id":"47e879f8-56bf-4d47-9b28-e4537fb45b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/reports/numbers/:accountId/total?includeDescendants=true","description":"This endpoint retrieves the total fax numbers report for a specific account and its descendants.
\nPath Parameter:
\naccountId (string, required): The ID of the account for which the total number of numbers is to be retrieved.Query Parameter:
\nincludeDescendants (boolean, required): A flag to indicate whether the subaccounts of the specified account should be included in the result.The response for this request is a JSON object representing the total fax numbers report for the specified account and its descendants.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Boolean | Default: true
\n","type":"text/plain"},"key":"includeDescendants","value":"true"}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"9924a01c-55dc-439e-978b-13a4e938b291","name":"Total Subaccount Numbers Report","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/reports/numbers/:accountId/total?includeDescendants=true","host":["https://api.documo.com"],"path":["fax","v2","reports","numbers",":accountId","total"],"query":[{"key":"includeDescendants","value":"true","description":"boolean, default true"}],"variable":[{"key":"accountId","value":null,"description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114e3fep\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\",\n \"total\": \"11\",\n \"totalForwarded\": \"1\"\n}"}],"_postman_id":"47e879f8-56bf-4d47-9b28-e4537fb45b73"},{"name":"FMC Total","id":"1a641111-7a1a-44f9-80f4-c2b6fb6986fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/reports/fmc/:accountId/total?includeDescendants=true","description":"This endpoint retrieves the total fax machine connectors for a specific account and its descendants.
\nPath Parameter:
\naccountId (string, required): The ID of the account for which the total number of FMC's is to be retrieved.Query Parameter:
\nincludeDescendants (boolean, required): A flag to indicate whether the subaccounts of the specified account should be included in the result.The response for this request can be documented as a JSON schema to describe the structure of the response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Boolean | Default: true
\n","type":"text/plain"},"key":"includeDescendants","value":"true"}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"2cc862ba-de6e-4dfa-83df-0d17c0de4bb9","name":"Total Faxbridge Report","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/reports/faxbridges/:accountId/total?includeDescendants=true","host":["https://api.documo.com"],"path":["fax","v2","reports","faxbridges",":accountId","total"],"query":[{"key":"includeDescendants","value":"true","description":"boolean, default true"}],"variable":[{"key":"accountId","value":"","description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\",\n \"total\": \"3\",\n \"totalActive\": \"1\"\n}"}],"_postman_id":"1a641111-7a1a-44f9-80f4-c2b6fb6986fa"}],"id":"62c84e31-2399-47f8-a86d-ae7947077bf6","description":"These reports are for parent accounts.
\n","_postman_id":"62c84e31-2399-47f8-a86d-ae7947077bf6","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This endpoint allows you to retrieve the total accounts under a specific account.
\naccountId: The ID of the account for which the report is to be retrieved.This request does not require a request body.
\nThe response for this request will be a JSON object representing the total report for the specified account.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Boolean, default true
\n","type":"text/plain"},"key":"includeDescendants","value":"true"}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"1fd87a08-40dc-4e10-99b1-7bb36f943721","name":"Total Subaccount Report","originalRequest":{"method":"GET","header":[{"key":"includeDescendants","value":"true","description":"boolean, default true"}],"url":{"raw":"https://api.documo.com/identity/v2/reports/accounts/:accountId/total","host":["https://api.documo.com"],"path":["identity","v2","reports","accounts",":accountId","total"],"variable":[{"key":"accountId","value":null,"description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\",\n \"total\": 1000\n}"}],"_postman_id":"de09e372-a9f1-48e4-884d-b3bf93047754"},{"name":"Subaccount Totals by Child Reseller","id":"5709ff8f-ee7b-4ed3-99e2-3f3bd95aade5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/reports/accounts/:accountId/children","description":"This endpoint makes an HTTP GET request to retrieve a list of child accounts for a specific account ID.
\naccountId: The ID of the account for which the report is to be retrieved.offset (number): The index from which the list of child accounts starts.limit (number): The maximum number of rows to be returned.output (csv | json): The format of the output.orderByField (string): The field by which the child accounts should be ordered.orderByDirection (string): The direction in which the child accounts should be ordered, either \"ASC\" or \"DESC\".accountType (string): Filter for the type of accounts to be retrieved.The response will be in JSON format and should be documented as a JSON schema.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Max 500
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"json | csv
\n","type":"text/plain"},"key":"output","value":""},{"disabled":true,"description":{"content":"total | accountType | accountName
\n","type":"text/plain"},"key":"orderByField","value":""},{"disabled":true,"description":{"content":"ASC | DESC
\n","type":"text/plain"},"key":"orderByDirection","value":""},{"disabled":true,"description":{"content":"reseller | customer | department | subaccount
\n","type":"text/plain"},"key":"accountType","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"4094f902-e58e-4a14-bd53-8b9dcf49f349","name":"Direct Child Account Summary Report","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/identity/v2/reports/accounts/:accountId/children?offset=0&limit=100&output=json&orderByField=total&orderByDirection=DESC&accountType=customer","host":["https://api.documo.com"],"path":["identity","v2","reports","accounts",":accountId","children"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"100","description":"Max 500"},{"key":"output","value":"json","description":"json | csv"},{"key":"orderByField","value":"total","description":"All available field"},{"key":"orderByDirection","value":"DESC","description":"ASC | DESC"},{"key":"accountType","value":"customer","description":"reseller | customer | department | subaccount"}],"variable":[{"key":"accountId","value":null,"description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": \"cb213c0b-6208-42f5-babe-c260a4d335e3\",\n \"accountName\": \"Organization 1\",\n \"accountType\": \"customer\",\n \"total\": \"26\"\n },\n {\n \"accountId\": \"95882e13-be18-4d92-9d86-756767c74fe6\",\n \"accountName\": \"Organization 2\",\n \"accountType\": \"customer\",\n \"total\": \"15\"\n }\n]"}],"_postman_id":"5709ff8f-ee7b-4ed3-99e2-3f3bd95aade5"},{"name":"Usage By Account","id":"3b661f60-00d1-4d2b-9c81-cc0eac941d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.documo.com/fax/v2/reports/usage/:accountId/children","description":"This endpoint retrieves the fax usage reports for child accounts under a specific account ID.
\naccountId: The ID of the account for which the report is to be retrieved.dateStart: The start date for the usage report.dateEnd: The end date for the usage reportoffset (number): The index from which the list of child accounts starts.limit (number): The maximum number of rows to be returned.output (csv | json): The format of the output.direction: Filter usage by direction, inbound or outboundaccountType: Filter on account typesorderByField (string): The field by which the child accounts should be ordered.orderByDirection (string): The direction in which the child accounts should be ordered, either \"ASC\" or \"DESC\".type: Filter usage typecountry: Filter by countryThe response for this request will be a JSON object representing the usage totals by child accounts report
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Start date as ISO 8601 string
\n","type":"text/plain"},"key":"dateStart","value":""},{"disabled":true,"description":{"content":"String | Required | End date as ISO 8601 string
\n","type":"text/plain"},"key":"dateEnd","value":""},{"disabled":true,"key":"offset","value":""},{"disabled":true,"description":{"content":"Max 500
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"json | csv
\n","type":"text/plain"},"key":"output","value":""},{"disabled":true,"description":{"content":"inbound | outbound
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"reseller | customer | department | subaccount
\n","type":"text/plain"},"key":"accountType","value":""},{"disabled":true,"description":{"content":"accountName | accountType | total | pages | pagesComplete | duration
\n","type":"text/plain"},"key":"orderByField","value":""},{"disabled":true,"description":{"content":"ASC | DESC
\n","type":"text/plain"},"key":"orderByDirection","value":""},{"disabled":true,"description":{"content":"outbound | inbound | fmc_inbound | fmc_outbound | forwarded
\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"String | 2 letter country code | ISO 3166-1 alpha-2
\n","type":"text/plain"},"key":"country","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"a06806c2-5b84-405e-b47a-1630ddda8d12","name":"Usage By Account","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/fax/v2/reports/usage/:accountId/children?dateStart=2023-04-01T00:00:00.000Z&dateEnd=2023-05-01T00:00:00.000Z","host":["https://api.documo.com"],"path":["fax","v2","reports","usage",":accountId","children"],"query":[{"key":"dateStart","value":"2023-04-01T00:00:00.000Z","description":"String | Required | Start date as ISO 8601 string"},{"key":"dateEnd","value":"2023-05-01T00:00:00.000Z","description":"String | Required | End date as ISO 8601 string"},{"key":"direction","value":"","description":"inbound | outbound","disabled":true},{"key":"type","value":"outbound","description":"outbound | inbound | fmc_inbound | fmc_outbound | forwarded","disabled":true},{"key":"country","value":"US","description":"String | 2 letter country code | ISO 3166-1 alpha-2","disabled":true},{"key":"output","value":"json","description":"json | csv","disabled":true},{"key":"offset","value":"0","disabled":true},{"key":"limit","value":"10","description":"Max 500","disabled":true},{"key":"accountType","value":"reseller","description":"reseller | customer | department | subaccount","disabled":true},{"key":"orderByField","value":"total","description":"accountName | accountType | total | pages | pagesComplete | duration","disabled":true},{"key":"orderByDirection","value":"DESC","description":"ASC | DESC","disabled":true}],"variable":[{"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"X-Total-Count","value":"1557"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"656"},{"key":"ETag","value":"W/\"290-/J2UInGxyXULwM8R6egppxv403Y\""},{"key":"Date","value":"Mon, 03 Jun 2024 14:20:46 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": \"d4545c68-c058-467c-b0fc-06bd629821ea\",\n \"accountName\": \"Test Account1\",\n \"accountType\": \"customer\",\n \"total\": 0,\n \"pages\": 0,\n \"pagesComplete\": 0,\n \"duration\": 0\n },\n {\n \"accountId\": \"55af4a61-a00d-43f6-8b3f-ccd798bbd44a\",\n \"accountName\": \"Test Account2\",\n \"accountType\": \"customer\",\n \"total\": 0,\n \"pages\": 0,\n \"pagesComplete\": 0,\n \"duration\": 0\n }\n]"}],"_postman_id":"3b661f60-00d1-4d2b-9c81-cc0eac941d91"},{"name":"Users By Account","id":"8abae39a-d76c-43e7-999e-b760844b98a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/reports/users/:accountId/children","description":"This endpoint makes an HTTP GET request to retrieve the total users and user roles broken down by account.
\nPath Parameter
\naccountId: The ID of the account for which the report is to be retrieved.Query Parameter
\noffset (number): The index from which the list of child accounts starts.
limit (number): The maximum number of rows to be returned.
output (csv | json): The format of the output.
accountType (string): Filter for the type of accounts to be retrieved.
orderByDirection (string): The direction in which the child accounts should be ordered, either \"ASC\" or \"DESC\".
orderByField (string): The field by which the child accounts should be ordered.
Max 500, Min 5
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"json | csv
\n","type":"text/plain"},"key":"output","value":""},{"disabled":true,"description":{"content":"reseller | customer | department | subaccount
\n","type":"text/plain"},"key":"accountType","value":""},{"disabled":true,"description":{"content":"ASC | DESC
\n","type":"text/plain"},"key":"orderByDirection","value":""},{"disabled":true,"description":{"content":"accountName | accountType | total | roleOwner | roleAdmin | roleSupport | roleUser
\n","type":"text/plain"},"key":"orderByField","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"595ada6e-fe9e-482b-8014-3acc2ca6df96","name":"Users By Account","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/identity/v2/reports/users/:accountId/children?limit=5&orderByDirection=ASC","host":["https://api.documo.com"],"path":["identity","v2","reports","users",":accountId","children"],"query":[{"key":"offset","value":"0","disabled":true},{"key":"limit","value":"5","description":"Max 500, Min 5"},{"key":"output","value":"csv","description":"json | csv","disabled":true},{"key":"accountType","value":"reseller","description":"reseller | customer | department | subaccount","disabled":true},{"key":"orderByDirection","value":"ASC","description":"ASC | DESC"},{"key":"orderByField","value":"roleOwner","description":"accountName | accountType | total | roleOwner | roleAdmin | roleSupport | roleUser","disabled":true}],"variable":[{"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"177"},{"key":"X-RateLimit-Reset","value":"40"},{"key":"X-Total-Count","value":"1557"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"890"},{"key":"ETag","value":"W/\"37a-p5Wmsa4oi6SfulksiDVdMEQMOzA\""},{"key":"Date","value":"Mon, 03 Jun 2024 14:28:48 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": \"9f8e9155-77f7-4541-8417-eb5a5e37489e\",\n \"accountName\": \"Test Account1\",\n \"accountType\": \"customer\",\n \"total\": \"8\",\n \"roleOwner\": \"1\",\n \"roleAdmin\": \"2\",\n \"roleSupport\": \"0\",\n \"roleUser\": \"5\"\n },\n {\n \"accountId\": \"880d37db-40db-4a79-ae1c-392998589678\",\n \"accountName\": \"Test Account2\",\n \"accountType\": \"customer\",\n \"total\": \"4\",\n \"roleOwner\": \"1\",\n \"roleAdmin\": \"3\",\n \"roleSupport\": \"0\",\n \"roleUser\": \"0\"\n },\n {\n \"accountId\": \"d0bf294f-05da-4353-aae6-9985e5a6f1bc\",\n \"accountName\": \"Test Account3\",\n \"accountType\": \"customer\",\n \"total\": \"1\",\n \"roleOwner\": \"1\",\n \"roleAdmin\": \"0\",\n \"roleSupport\": \"0\",\n \"roleUser\": \"0\"\n },\n {\n \"accountId\": \"ecfb82bf-6d16-4855-88e0-e57647948c15\",\n \"accountName\": \"Test Account4\",\n \"accountType\": \"customer\",\n \"total\": \"1\",\n \"roleOwner\": \"1\",\n \"roleAdmin\": \"0\",\n \"roleSupport\": \"0\",\n \"roleUser\": \"0\"\n },\n {\n \"accountId\": \"682fd24c-c33a-4f79-99d0-3c3cd63296ec\",\n \"accountName\": \"Test Account5\",\n \"accountType\": \"customer\",\n \"total\": \"2\",\n \"roleOwner\": \"1\",\n \"roleAdmin\": \"1\",\n \"roleSupport\": \"0\",\n \"roleUser\": \"0\"\n }\n]"}],"_postman_id":"8abae39a-d76c-43e7-999e-b760844b98a2"},{"name":"Numbers By Account","id":"9d64e491-e1d1-476e-aca7-d632de4d27a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/reports/numbers/:accountId/children","description":"This endpoint makes an HTTP GET request to retrieve the total numbers broken down by account.
\nPath Parameter
\naccountId: The ID of the account for which the report is to be retrieved.Query Parameter
\noffset (number): The index from which the list of child accounts starts.
limit (number): The maximum number of rows to be returned.
output (csv | json): The format of the output.
accountType (string): Filter for the type of accounts to be retrieved.
orderByDirection (string): The direction in which the child accounts should be ordered, either \"ASC\" or \"DESC\".
orderByField (string): The field by which the child accounts should be ordered.
Max 500, Min 5
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"json | csv
\n","type":"text/plain"},"key":"output","value":""},{"disabled":true,"description":{"content":"reseller | customer | department | subaccount
\n","type":"text/plain"},"key":"accountType","value":""},{"disabled":true,"description":{"content":"ASC | DESC
\n","type":"text/plain"},"key":"orderByDirection","value":""},{"disabled":true,"description":{"content":"accountName | accountType | total
\n","type":"text/plain"},"key":"orderByField","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"9d605bb8-f5fe-43c8-a38e-a6ba033c097a","name":"Numbers By Account","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/reports/numbers/:accountId/children?limit=5&orderByDirection=ASC&orderByField=accountName","host":["https://api.documo.com"],"path":["fax","v2","reports","numbers",":accountId","children"],"query":[{"key":"offset","value":"","disabled":true},{"key":"limit","value":"5","description":"Max 500, Min 5"},{"key":"output","value":"","description":"json | csv","disabled":true},{"key":"accountType","value":"","description":"reseller | customer | department | subaccount","disabled":true},{"key":"orderByDirection","value":"ASC","description":"ASC | DESC"},{"key":"orderByField","value":"accountName","description":"accountName | accountType | total"}],"variable":[{"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"176"},{"key":"X-RateLimit-Reset","value":"9"},{"key":"X-Total-Count","value":"1557"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"975"},{"key":"ETag","value":"W/\"3cf-nOgNzlJvSSiYAfgXf9whtjbMs64\""},{"key":"Date","value":"Mon, 03 Jun 2024 14:54:35 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": \"9f8e9155-77f7-4541-8417-eb5a5e37489e\",\n \"accountName\": \"Account 1\",\n \"accountType\": \"customer\",\n \"total\": \"4\"\n },\n {\n \"accountId\": \"880d37db-40db-4a79-ae1c-392998589678\",\n \"accountName\": \"Account 2\",\n \"accountType\": \"customer\",\n \"total\": \"32\"\n },\n {\n \"accountId\": \"d0bf294f-05da-4353-aae6-9985e5a6f1bc\",\n \"accountName\": \"Account 3\",\n \"accountType\": \"customer\",\n \"total\": \"5\"\n },\n {\n \"accountId\": \"ecfb82bf-6d16-4855-88e0-e57647948c15\",\n \"accountName\": \"Account 4\",\n \"accountType\": \"customer\",\n \"total\": \"11\"\n },\n {\n \"accountId\": \"682fd24c-c33a-4f79-99d0-3c3cd63296ec\",\n \"accountName\": \"Account 5\",\n \"accountType\": \"customer\",\n \"total\": \"0\"\n }\n]"}],"_postman_id":"9d64e491-e1d1-476e-aca7-d632de4d27a4"},{"name":"FMC By Account","id":"28c64b66-4231-457c-945a-f1a580065677","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/reports/fmc/:accountId/children","description":"This endpoint makes a request to retrieve the total machine connectors broken down by account.
\nPath Parameter
\naccountId: The ID of the account for which the report is to be retrieved.Query Parameter
\noffset (number): The index from which the list of child accounts starts.
limit (number): The maximum number of rows to be returned.
accountType (string): Filter for the type of accounts to be retrieved.
orderByDirection (string): The direction in which the child accounts should be ordered, either \"ASC\" or \"DESC\".
orderByField (string): The field by which the child accounts should be ordered.
Max 500
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"json | csv
\n","type":"text/plain"},"key":"output","value":""},{"disabled":true,"description":{"content":"reseller | customer | department | subaccount
\n","type":"text/plain"},"key":"accountType","value":""},{"disabled":true,"description":{"content":"ASC | DESC
\n","type":"text/plain"},"key":"orderByDirection","value":""},{"disabled":true,"description":{"content":"accountName | accountType | total | totalActive
\n","type":"text/plain"},"key":"orderByField","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"4558fa2f-a51f-4c77-ac6e-6862af49b474","name":"fax/v2/reports/faxbridges/:accountId/children","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/reports/faxbridges/:accountId/children?offset=0&limit=100&output=json&orderByField=accountName&orderByDirection=ASC&accountType=customer","host":["https://api.documo.com"],"path":["fax","v2","reports","faxbridges",":accountId","children"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"100","description":"Max 500"},{"key":"output","value":"json","description":"json | csv"},{"key":"orderByField","value":"accountName","description":"all available fields"},{"key":"orderByDirection","value":"ASC","description":"ASC | DESC"},{"key":"accountType","value":"customer","description":"reseller | customer | department | subaccount"}],"variable":[{"key":"accountId","value":"","description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": \"9f8e9155-77f7-4541-8417-eb5a5e373f4f\",\n \"accountName\": \"Account 1\",\n \"accountType\": \"customer\",\n \"total\": \"1\",\n \"totalActive\": \"1\"\n },\n {\n \"accountId\": \"3fa06a94-137d-4651-a9a0-5d36b72689876\",\n \"accountName\": \"Account 2\",\n \"accountType\": \"customer\",\n \"total\": \"2\",\n \"totalActive\": \"1\"\n }\n]"}],"_postman_id":"28c64b66-4231-457c-945a-f1a580065677"},{"name":"Subaccount Custom Plans Reports","id":"802fd60c-eae1-47b2-a2df-1765a25df4aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/reports/accounts/:accountId/children/:product/plans","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Max 500, Min 5
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"csv | json
\n","type":"text/plain"},"key":"output","value":""}],"variable":[{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"accountId"},{"description":{"content":"String | Required | 'fax' or 'sign'
\n","type":"text/plain"},"type":"any","value":"","key":"product"}]}},"response":[{"id":"499b3668-414d-4bde-a8ee-3cf13c96c74d","name":"identity/v2/reports/accounts/:accountId/children/:product/plans","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/identity/v2/reports/accounts/:accountId/children/:product/plans?offset=0&limit=5&output=json","host":["https://api.documo.com"],"path":["identity","v2","reports","accounts",":accountId","children",":product","plans"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"5"},{"key":"output","value":"json","description":"csv | json"}],"variable":[{"key":"accountId","value":null},{"key":"product","value":"fax","description":"'fax' or 'sign'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"178"},{"key":"Date","value":"Tue, 18 Apr 2023 15:24:33 GMT"},{"key":"X-RateLimit-Reset","value":"53"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.0.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"197"},{"key":"ETag","value":"W/\"c5-+fym3qoRJaBnp/ktNBOUWJQq2b0\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": \"16e1a436-e13c-487d-992c-aa481d66a46c\",\n \"accountName\": \"Account 1\",\n \"accountType\": \"subaccount\",\n \"planId\": \"2224160e-b50a-468e-8491-92abcb75544d\",\n \"planName\": \"A Custom Plan\",\n \"planRenewal\": 1\n }\n]"}],"_postman_id":"802fd60c-eae1-47b2-a2df-1765a25df4aa"}],"id":"e3b8ea9b-7d1e-48c0-b7cc-4bac4eefbf4b","description":"These reports are for departments and subaccounts.
\n","_postman_id":"e3b8ea9b-7d1e-48c0-b7cc-4bac4eefbf4b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"faxId"}]}},"response":[],"_postman_id":"c5b5d5b9-15c6-4ebd-bd2b-9bea32456b50"},{"name":"Download Inbound Fax","id":"30ffa8a0-73aa-4cd2-9e36-eeb184773f3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{API_KEY}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.documo.com/fax/v2/faxes/inbound/:faxId/download","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"faxId"}]}},"response":[],"_postman_id":"30ffa8a0-73aa-4cd2-9e36-eeb184773f3f"},{"name":"Download Streaming Pages (Beta)","id":"f6dc1126-6543-410d-9cda-9fdf18670eb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/fax/:faxId/download/stream?format=pdf&pages=1-2","description":"This endpoint downlaods inbound pages as they're being transmitted.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"'pdf' | 'tiff'
\n","type":"text/plain"},"key":"format","value":"pdf"},{"description":{"content":"Page number or range (e.g., '2' or '2-4')
\n","type":"text/plain"},"key":"pages","value":"1-2"}],"variable":[{"id":"840e3a3e-a5d5-4c22-90cf-bc48d40b975e","description":{"content":"Fax Message Id (UUID)
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"faxId"}]}},"response":[],"_postman_id":"f6dc1126-6543-410d-9cda-9fdf18670eb2"}],"id":"399a1010-6952-45e9-9faa-56a1bfc08897","_postman_id":"399a1010-6952-45e9-9faa-56a1bfc08897","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This GET endpoint allows to search for available phone numbers for provisioning. It accepts query parameters—such as area code, geographic region, or rate center —to filter the search criteria and returns a JSON array of matching phone numbers along with essential metadata.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Optional | US City
\n","type":"text/plain"},"key":"city","value":"New York"},{"disabled":true,"description":{"content":"String | 2 Letter state code | Optional | US State identifier
\n","type":"text/plain"},"key":"state","value":"NY"},{"disabled":true,"description":{"content":"Number | Optional | Area code
\n","type":"text/plain"},"key":"areaCode","value":"917"},{"disabled":true,"description":{"content":"Number | Optional | Telephone prefix
\n","type":"text/plain"},"key":"prefix","value":"246"},{"disabled":true,"description":{"content":"String | Optional | Rate center
\n","type":"text/plain"},"key":"rateCenter","value":"NWYRCYZN13"},{"disabled":true,"description":{"content":"Number | Optional | Page limit
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"a3cc0063-169e-4200-b1d3-9862d49b4bf7"},{"name":"Provision","id":"434c7aee-6541-446e-9f01-b9b565ac53a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"order","description":"Enum (order, forwarded, create) | Optional | Default: order | Type of provisioning
\n","type":"text","uuid":"0f32fd9a-b7d1-493e-892f-7d22afd11931"},{"key":"numbers","value":"12063505633,12063505654","description":"String | Required | Comma separated list of E164-LITE formatted numbers
\n","type":"text","uuid":"d1d265f5-d675-4f48-a09b-58fa5eb9a93b"},{"key":"accountId","value":"00000000-0000-0000-0000-000000000000","description":"String | Optional | ID of the account who will manage the number
\n","type":"text","uuid":"d47b84ad-9675-4c9d-addb-2c664fd63a5a"}]},"url":"https://api.documo.com/fax/v2/numbers/provision","description":"This POST endpoint provisions a selected phone number by assigning it to an account. The endpoint accepts a JSON payload with details such as the phone number list and type of provisioning. On success, it returns a confirmation with a unique identifier and relevant metadata.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Number | Optional | Default: 1 | Quantity of number to be provisioned
\n","type":"text","uuid":"42081d30-4725-4d59-9c57-92b39e678091"},{"key":"prefix","value":"917","description":"Number | Optional | Telephone prefix
\n","type":"text","uuid":"d6bbdc98-f123-444e-bc9b-27202b6f893d"},{"key":"accountId","value":"00000000-0000-0000-0000-000000000000","description":"String | Optional | ID of the account who will manage the number
\n","type":"text","uuid":"daa4000a-fc0a-4bca-a3fe-abea32648129"}]},"url":"https://api.documo.com/fax/v2/numbers/provision/toll-free","description":"This POST endpoint provisions a toll free number and assigning it to an account. The endpoint accepts a JSON payload with details such as the quantity of numbers and number prefix to be provisioned. On success, it returns a confirmation with a unique identifier and relevant metadata.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This public API provides a process for provisioning fax numbers in two distinct ways:
\nRegular Fax Numbers:
\nSearch Step:
\nBegin by using the search endpoint to retrieve a catalog of available fax numbers. Various filters such as area code, geographic region, and other criteria help narrow down the selection.
\nProvision Step:
\nOnce a suitable fax number(s) is/are identified, make an API call to the provision endpoint. This call assigns the selected fax number(s), returning activation details including a unique identifier and status confirmation.
\nToll-Free Fax Numbers:
\nThis approach ensures an efficient and streamlined process for provisioning both regular and toll-free fax numbers through the public API.
\n","_postman_id":"db3cc531-1edb-475e-8bc8-8a0906d8410c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Numbers in E164 format with no plus sign, separated by comma. E.g. 14344018881,17036258854
\n","type":"text","uuid":"1f61cb43-2458-4798-b415-0f5b32707ffa"}]},"url":"https://api.documo.com/fax/v2/numbers/portin/availability","description":"This REST API endpoint is designed to verify the number portability of a given telephone number list. When you send a portability check request, the API takes a fax number list as input and returns a JSON response indicating whether the numbers are eligible for porting between telecom service providers. The response typically includes details such as the current carrier and the portability eligibility. This endpoint is essential for ensuring smooth transitions during carrier switches and for validating portability eligibility in real time.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This GET endpoint returns a JSON array listing the port-ins that have been processed. Each entry in the list typically includes details like the phone number list, the date of the port-in and any relevant metadata. Query parameters may be available to support pagination and filtering of results.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Enum (draft, submitted, foc-confirmed, cancel-pending, action-required, cancelled, complete) | Optional | Status of port ins
\n","type":"text/plain"},"key":"status","value":null},{"disabled":true,"description":{"content":"String | Required | Default: 30 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":null},{"disabled":true,"description":{"content":"String | Required | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[{"id":"f2679f0f-9f6b-4932-9bee-84126b4c1e26","name":"Get All Portins - Success","originalRequest":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2999"},{"key":"ETag","value":"W/\"bb7-ZBwhzL+k2wFx0GHuALt+DhyJ4Xo\""},{"key":"Date","value":"Mon, 03 Jun 2024 19:23:46 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"rows\": [\n {\n \"isInternal\": false,\n \"status\": \"complete\",\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"provider\": \"inteliquent\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"chatroomId\": null,\n \"numberType\": \"local\",\n \"authName\": \"asdfghnm\",\n \"endUserAccountNumber\": \"12378\",\n \"endUserName\": \"asdfgbnm\",\n \"endUserPhoneNumber\": \"+14344018888\",\n \"endUserPostalCode\": \"80219\",\n \"endUserStreetAddress\": \"asdfgnm\",\n \"endUserExtendedAddress\": null,\n \"endUserCountryCode\": \"US\",\n \"endUserRegion\": \"AK\",\n \"endUserCity\": \"Denver\",\n \"requestedFocDate\": \"2023-10-20T21:40:07.000Z\",\n \"focDate\": null,\n \"pin\": null,\n \"carrier\": \"Cingular Wireless/2\",\n \"label\": null,\n \"createdAt\": \"2023-10-05T21:41:55.000Z\",\n \"updatedAt\": \"2024-05-01T19:02:01.000Z\",\n \"numbers\": [],\n \"errors\": [],\n \"account\": {\n \"portingNotificationEmails\": [\n \"user1@example.com\",\n \"user2@example.com\",\n \"user3@example.com\"\n ]\n },\n \"files\": []\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"b3f21928-834b-495f-927e-ce4d94f03822"},{"name":"Get One Port","id":"6794d76a-26d3-4caa-bb8e-85ff3e5522d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId","description":"This GET endpoint retrieves the details of a specific port-in record by using an id parameter. The response returns a JSON object containing key attributes such as the phone number list, port-in date and additional metadata related to the port-in request.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"}]}},"response":[{"id":"638b86b0-79a8-452d-ac92-9190b9014564","name":"Get One Portin - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/numbers/portin/:portinId","host":["https://api.documo.com"],"path":["fax","v2","numbers","portin",":portinId"],"variable":[{"key":"portinId","value":"00000000-0000-0000-0000-000000000000","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2989"},{"key":"ETag","value":"W/\"bad-POmUBnhjjnc0rD4mYNgkElQ+M78\""},{"key":"Date","value":"Mon, 03 Jun 2024 18:55:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"isInternal\": false,\n \"status\": \"complete\",\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"provider\": \"inteliquent\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"chatroomId\": null,\n \"numberType\": \"local\",\n \"authName\": \"asdfghnm\",\n \"endUserAccountNumber\": \"12378\",\n \"endUserName\": \"asdfgbnm\",\n \"endUserPhoneNumber\": \"+14344018888\",\n \"endUserPostalCode\": \"80219\",\n \"endUserStreetAddress\": \"asdfgnm\",\n \"endUserExtendedAddress\": null,\n \"endUserCountryCode\": \"US\",\n \"endUserRegion\": \"AK\",\n \"endUserCity\": \"Denver\",\n \"requestedFocDate\": \"2023-10-20T21:40:07.000Z\",\n \"focDate\": null,\n \"pin\": null,\n \"carrier\": \"Cingular Wireless/2\",\n \"label\": null,\n \"createdAt\": \"2023-10-05T21:41:55.000Z\",\n \"updatedAt\": \"2024-05-01T19:02:01.000Z\",\n \"numbers\": [],\n \"errors\": [],\n \"account\": {\n \"portingNotificationEmails\": [\n \"user1@example.com\",\n \"user2@example.com\",\n \"user3@example.com\"\n ]\n },\n \"files\": []\n}"}],"_postman_id":"6794d76a-26d3-4caa-bb8e-85ff3e5522d0"},{"name":"Create New Port","id":"8282cb98-7cbc-4a8d-8b40-3546654c36cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"accountId","value":"00000000-0000-0000-0000-000000000000","description":"String | Optional | Account ID
\n","type":"text","uuid":"d08bce8b-95bd-4ddd-9c58-985698e27e0f","disabled":true},{"key":"numberType","value":"local","description":"Enum (local,toll-free) | Optional | Default: local | Type of numbers
\n","type":"text","uuid":"34e6c5cc-b736-4dca-a0f1-ad7ee122ff57"},{"key":"authName","value":"User123","description":"String | Name of person authorizing the port request
\n","type":"text","uuid":"44b93887-5320-4992-a3ce-ae8a904fdef6"},{"key":"endUserAccountNumber","value":"12345","type":"text","uuid":"265e4229-c844-4440-81f1-66da63726b66"},{"key":"endUserName","value":"User123","description":"String | Person Name or Company name requesting the port
\n","type":"text","uuid":"2abecdd1-162a-4a4e-ac2f-4034c307d452"},{"key":"endUserPhoneNumber","value":"4344010000","description":"String | Billing phone number associated with these phone numbers
\n","type":"text","uuid":"27513471-c90d-4761-84d0-67b1de5e940b"},{"key":"endUserPostalCode","value":"90210","description":"String | Postal Code of billing address
\n","type":"text","uuid":"a72638b2-11ed-4f46-8b88-522255ebe265"},{"key":"endUserStreetAddress","value":"123 Road St.","description":"String | First line of billing address
\n","type":"text","uuid":"d84b51e9-e043-424b-ac92-4545e3cba9ea"},{"key":"endUserRegion","value":"CA","description":"String | Two character state abbreviation of billing address
\n","type":"text","uuid":"687ad940-30fb-4e36-8971-6a6c8e6d1dc4"},{"key":"endUserCity","value":"Beverly Hills","description":"String | City of billing address
\n","type":"text","uuid":"9da397d9-9a11-423f-825e-40e52b08c15c"},{"key":"numbers","value":"19175365849,19173999637","description":"String | Required | Comma separated list of E164 lite formatted numbers
\n","type":"text","uuid":"d1c981a6-5c66-45c2-bb31-a727e6af6cce"},{"key":"requestedFocDate","value":"2025-08-06","description":"String | Optional | Requested FOC date
\n","type":"text","uuid":"1a2248cb-eec9-427c-a699-c165a569b915"}]},"url":"https://api.documo.com/fax/v2/numbers/portin","description":"This REST API endpoint is designed to create a new port request for transferring a telephone number from one service provider to documo. It accepts an HTTP POST request with a JSON payload containing all the necessary details for initiating the porting process.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Enum (local,toll-free) | Optional | Default: local | Type of numbers
\n","type":"text","uuid":"cf8d8886-28b4-4a3d-9cd4-2d8f1ec9d296"},{"key":"authName","value":"User123","description":"String | Name of person authorizing the port request
\n","type":"text","uuid":"3aad06ed-c64b-40c8-aff3-0c50871f0d5b"},{"key":"endUserAccountNumber","value":"12345","type":"text","uuid":"a0e7db70-53cf-4da4-b96f-0e75977facd7"},{"key":"endUserName","value":"User123","description":"String | Person Name or Company name requesting the port
\n","type":"text","uuid":"69a38c65-9d6f-4037-9919-a17a461e35b7"},{"key":"endUserPhoneNumber","value":"4344010000","description":"String | Billing phone number associated with these phone numbers
\n","type":"text","uuid":"5d953873-237e-4b7d-a4b8-929cbabcdeaf"},{"key":"endUserPostalCode","value":"90210","description":"String | Postal Code of billing address
\n","type":"text","uuid":"8e952892-5c03-403d-aaa5-b8d98aade6a7"},{"key":"endUserStreetAddress","value":"123 Road St.","description":"String | First line of billing address
\n","type":"text","uuid":"82cd664e-22d8-4f2f-a789-ca2bd0411ae3"},{"key":"endUserRegion","value":"CA","description":"String | Two character state abbreviation of billing address
\n","type":"text","uuid":"1d90ffe7-77a9-48a6-860f-0825d988aa33"},{"key":"endUserCity","value":"Beverly Hills","description":"String | City of billing address
\n","type":"text","uuid":"4502d714-4e2c-49fa-afac-e1d18a2884ec"},{"key":"requestedFocDate","value":"2025-08-06","description":"String | Optional | Requested FOC date
\n","type":"text","uuid":"c93a98fb-ab6a-4909-be60-d26017e4dd06"}]},"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId","description":"This REST API endpoint is designed to update an existing port request for transferring a telephone number from one service provider to documo. It accepts an HTTP PATCH request with a JSON payload containing all the necessary details for updating the port in request.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"}]}},"response":[{"id":"b9031462-c99b-4d0f-895a-0909eb0b51a3","name":"Update Portin - Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"numberType\": \"local\",\n \"authName\": \"User123\",\n \"endUserAccountNumber\": \"12345\",\n \"endUserName\": \"User123\",\n \"endUserPhoneNumber\": \"4344010000\",\n \"endUserPostalCode\": \"80219\",\n \"endUserStreetAddress\": \"123 Road St.\",\n \"endUserRegion\": \"CO\",\n \"endUserCity\": \"Denver\",\n \"requestedFocDate\": \"2024-06-06\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/fax/v2/numbers/portin/:portinId","host":["https://api.documo.com"],"path":["fax","v2","numbers","portin",":portinId"],"variable":[{"key":"portinId","value":"293292ef-a463-45a4-8d5f-6d43e4afbe6c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"178"},{"key":"X-RateLimit-Reset","value":"4"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1093"},{"key":"ETag","value":"W/\"445-CDqDQo9SD2Tpk6T2DhrIsyGm4vM\""},{"key":"Date","value":"Mon, 03 Jun 2024 19:45:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"isInternal\": false,\n \"status\": \"draft\",\n \"uuid\": \"293292ef-a463-45a4-8d5f-6d43e4afbe6c\",\n \"provider\": \"inteliquent\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"chatroomId\": null,\n \"numberType\": \"local\",\n \"authName\": \"User123\",\n \"endUserAccountNumber\": \"12345\",\n \"endUserName\": \"User123\",\n \"endUserPhoneNumber\": \"4344010000\",\n \"endUserPostalCode\": \"80219\",\n \"endUserStreetAddress\": \"123 Road St.\",\n \"endUserExtendedAddress\": null,\n \"endUserCountryCode\": \"US\",\n \"endUserRegion\": \"CO\",\n \"endUserCity\": \"Denver\",\n \"requestedFocDate\": \"2024-06-06T00:00:00.000Z\",\n \"focDate\": null,\n \"pin\": null,\n \"carrier\": \"Sprint PCS/2\",\n \"label\": null,\n \"createdAt\": \"2024-06-03T19:30:56.000Z\",\n \"updatedAt\": \"2024-06-03T19:45:13.000Z\",\n \"numbers\": [\n {\n \"createdAt\": \"2024-06-03T19:30:56.000Z\",\n \"updatedAt\": \"2024-06-03T19:30:56.000Z\",\n \"uuid\": \"454e0a2b-76a5-46a6-be67-adeb3fd5a29a\",\n \"ownedBy\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"managedBy\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"portReplaceNumberId\": null,\n \"number\": \"4344018888\",\n \"provider\": \"inteliquent\",\n \"pendingRelease\": false,\n \"pendingPort\": true,\n \"portSubRequestId\": null,\n \"pendingUntil\": null,\n \"isLocal\": false,\n \"deletedAt\": null\n }\n ]\n}"}],"_postman_id":"4371fb97-c705-41da-a05b-3d99b1c90d03"},{"name":"Delete Port","id":"1238795f-bdb0-4ce2-85e4-44191115b4f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId","description":"This REST API endpoint is designed to delete an existing port in request. It accepts an HTTP DELETE request with a port in Id in endpoint parameter.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This REST API endpoint is designed to submit an existing port request for transferring a telephone number from one service provider to documo. It accepts an HTTP POST request with a JSON payload containing all the necessary details for submitted port in request.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"}]}},"response":[],"_postman_id":"8ce6deb1-e70b-42db-bcfe-5bec85ffc63c"},{"name":"Cancel Port","id":"17c4bb36-e9fe-45d5-82dc-49fe4a5b6abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId/cancel","description":"This REST API endpoint is designed to cancel an existing submitted port request for transferring a telephone number from one service provider to documo. It accepts an HTTP POST request with port in identifier.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"}]}},"response":[],"_postman_id":"17c4bb36-e9fe-45d5-82dc-49fe4a5b6abb"},{"name":"Create Number Replacement","id":"b174b6f1-a629-4751-8814-884076ab70fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"numberToReplaceId","value":"00000000-0000-0000-0000-000000000000","description":"String | Required | UUID of number to be replaced
\n","type":"text","uuid":"b8e92f3a-d066-4ebf-b521-efdf94fa1ec9"},{"key":"replacementNumberId","value":"00000000-0000-0000-0000-000000000000","description":"String | Required | UUID of number replacement
\n","type":"text","uuid":"4e268b20-37ef-41e9-b164-5664c59bd667"}]},"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId/numberReplacement","description":"This REST API endpoint is designed to create an phone number replacement in port in request. It accepts an HTTP POST request with a JSON payload containing all the necessary details for creating a fax number replacement.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"portinId"}]}},"response":[],"_postman_id":"b174b6f1-a629-4751-8814-884076ab70fc"},{"name":"Upload Port Document","id":"df83e03c-14bc-48a5-b945-6aa5368f69e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fileName","value":"test.tiff","type":"text"},{"key":"file","type":"file","src":"postman-cloud:///1eeb6d19-ebde-4810-a76c-13579a5f9f40"}]},"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId/documents","description":"This REST API endpoint is designed to upload supporting document for an existing port request. It accepts an HTTP POST request with form-data content type that would include the file image and file name.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"}]}},"response":[{"id":"39ff9ac5-885e-4d80-9c25-f9fb3e6df6c7","name":"Upload Portin Document - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fileName","value":"test.tiff","type":"text"},{"key":"file","type":"file","src":"postman-cloud:///1eeb6d19-ebde-4810-a76c-13579a5f9f40"}]},"url":{"raw":"https://api.documo.com/fax/v2/numbers/portin/:portinId/documents","host":["https://api.documo.com"],"path":["fax","v2","numbers","portin",":portinId","documents"],"variable":[{"key":"portinId","value":"293292ef-a463-45a4-8d5f-6d43e4afbe6c"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"385"},{"key":"ETag","value":"W/\"181-AloQF6XeMGMw+Zzgtk8I9rqiN1o\""},{"key":"Date","value":"Mon, 03 Jun 2024 19:58:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"772ae536-9005-44e8-9be7-cac19b7f31f1\",\n \"portinId\": \"293292ef-a463-45a4-8d5f-6d43e4afbe6c\",\n \"fileName\": \"ExampleSimpleTiff.tif\",\n \"size\": 453862,\n \"mimeType\": \"image/tiff\",\n \"bucket\": \"documo-drive-dev\",\n \"bucketName\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p/293292ef-a463-45a4-8d5f-6d43e4afbe6c/772ae536-9005-44e8-9be7-cac19b7f31f1/ExampleSimpleTiff.tif\",\n \"createdAt\": \"2024-06-03T19:58:34.000Z\"\n}"}],"_postman_id":"df83e03c-14bc-48a5-b945-6aa5368f69e4"},{"name":"Get Documents in Port","id":"986b41c2-de51-40ea-8d31-6ebe8dee6531","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId/documents","description":"This REST API endpoint is designed to retrieve supporting documents metadata for an existing port request.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"}]}},"response":[{"id":"4a9ede9a-4e84-4972-b124-88c4fa870dbe","name":"Get Portin Document","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/numbers/portin/:portinId/documents","host":["https://api.documo.com"],"path":["fax","v2","numbers","portin",":portinId","documents"],"variable":[{"key":"portinId","value":"293292ef-a463-45a4-8d5f-6d43e4afbe6c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.12.2"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"387"},{"key":"ETag","value":"W/\"183-h/Saxgf5On4Iq09XGMhVFlmQ7iI\""},{"key":"Date","value":"Mon, 03 Jun 2024 20:04:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2024-06-03T19:58:34.000Z\",\n \"uuid\": \"772ae536-9005-44e8-9be7-cac19b7f31f1\",\n \"portinId\": \"293292ef-a463-45a4-8d5f-6d43e4afbe6c\",\n \"fileName\": \"ExampleSimpleTiff.tif\",\n \"size\": 453862,\n \"mimeType\": \"image/tiff\",\n \"bucket\": \"documo-drive-dev\",\n \"bucketName\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0p/293292ef-a463-45a4-8d5f-6d43e4afbe6c/772ae536-9005-44e8-9be7-cac19b7f31f1/ExampleSimpleTiff.tif\"\n }\n]"}],"_postman_id":"986b41c2-de51-40ea-8d31-6ebe8dee6531"},{"name":"Download Document in Port","id":"f135584a-8835-432d-a4d4-8b318ac755fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId/documents/:documentId/download","description":"This REST API endpoint is designed to retrieve supporting documents that are uploaded for an existing port request. It accepts an GET request that contains parameters of port in identifier and document identifier
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"},{"id":"a09016c1-b062-4d7b-aedf-61bc48f9949e","description":{"content":"String | Required | UUID of document
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[],"_postman_id":"f135584a-8835-432d-a4d4-8b318ac755fa"},{"name":"Delete Document in Port","id":"5bbacd3f-4eb1-456d-86aa-0ac7a852554a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/fax/v2/numbers/portin/:portinId/documents/:documentId","description":"This REST API endpoint is designed to delete a supporting document that is uploaded for an existing port request. It accepts an DELETE request that contains parameters of port in identifier and document identifier.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID of port
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"portinId"},{"id":"71c79cb8-3f4a-470d-aebd-2e467abd7144","description":{"content":"String | Required | UUID of document
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[],"_postman_id":"5bbacd3f-4eb1-456d-86aa-0ac7a852554a"}],"id":"8989b0f8-eb32-437a-a0a0-85144d5cb7f5","description":"Number porting—also known as “number portability”—is the process by which a customer moves their existing telephone number from one service provider to another while retaining the same digits. This ensures uninterrupted service and spares the subscriber the hassle of notifying everyone about a new number.
\nWorkflow:
\nPortability Check
\nFirst, verify that the phone number is eligible to be ported. The system responds with “isPortable” along with any relevant carrier information.
\nCreate Draft Port Request
Once eligibility is confirmed, you initialize a new port‑in request in Draft status. At this stage you collect billing information, the old‑carrier account number, the phone number to be ported, and optionally a preferred port‑in date. The system returns a unique port in request identifier (uuid) that you will use for all subsequent actions.
Update Draft Port Request
While the request remains in Draft you can modify any of its details. If the customer wants to change the port‑in date, billing information or you need to correct an entry, you send only the fields that have changed. The system merges your updates, logs which fields were modified, and stamps the request with the update time.
Upload Supporting Documents
Carriers require proof of authorization or billing to approve a port. You attach scanned or photographed documents—such as a signed Letter of Authorization (LOA). The system stores these documents alongside the draft.
Submit Port Request
When all required information and documents are in place, you submit the request to lock it in and send it to the carrier network. The request transitions from Draft to Submitted. This action triggers the actual inter‑carrier coordination.
Additional useful resource endpoints:
Delete Draft Port Request
If the customer decides not to proceed before submission, you can delete the draft. This permanently removes the request record and any attached documents, keeping your system free of unused drafts.
Cancel Submitted Port Request
Even after submission, you may need to halt the process—perhaps the change of mind. Cancelling a Submitted request moves it into Cancelled status and notifies the carriers to stop or roll back the port. The system records the cancellation time and any provided reason.
String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"f53ba1e9-05b1-49d7-ab65-71b779120053"}],"id":"bc8a7c3e-eb85-402c-a1bc-63daecd426db","_postman_id":"bc8a7c3e-eb85-402c-a1bc-63daecd426db","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Tag UUID
\n","type":"text"},{"key":"type","value":"","description":"inbound | outbound
\n","type":"text"}]},"url":"https://api.documo.com/fax/v2/numbers/tags/:numberId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Number UUID
\n","type":"text/plain"},"type":"any","value":"","key":"numberId"}]}},"response":[{"id":"ce1c8ea2-caa7-4a98-be89-afdbcc51e45d","name":"Assign tag to fax number","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Tag UUID","type":"text"},{"key":"type","value":"inbound","description":"inbound | outbound","type":"text"}]},"url":{"raw":"https://api.documo.com/fax/v2/numbers/tags/:numberId","host":["https://api.documo.com"],"path":["fax","v2","numbers","tags",":numberId"],"variable":[{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Number UUID"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"tagId\": \"d1077489-5ea1-4db1-9760-853f175e8288\",\n \"numberId\": \"d1077489-5ea1-4db1-9760-853f175e8288\",\n \"type\": \"inbound\",\n \"createdAt\": \"2024-06-25T16:23:14.000Z\"\n}"}],"_postman_id":"9648c5e3-62b6-41aa-9f18-b7baad74bce5"},{"name":"Remove tag from fax number","id":"162572ed-3df7-4c13-bd28-13d5e28829f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"tagId","value":"","description":"String | Required | Tag UUID
\n","type":"text"},{"key":"type","value":"","description":"inbound | outbound
\n","type":"text"}]},"url":"https://api.documo.com/fax/v2/numbers/tags/:numberId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Number UUID
\n","type":"text/plain"},"type":"any","value":"","key":"numberId"}]}},"response":[{"id":"94535cde-00b8-4726-b2fb-28ece71a0927","name":"Remove tag from fax number","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Tag UUID","type":"text"},{"key":"type","value":"inbound","description":"inbound | outbound","type":"text"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/fax/v2/numbers/tags/:numberId","host":["https://api.documo.com"],"path":["fax","v2","numbers","tags",":numberId"],"variable":[{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Number UUID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"162572ed-3df7-4c13-bd28-13d5e28829f8"}],"id":"2aea375a-6d4c-40a7-a494-7c9f031fa8e8","_postman_id":"2aea375a-6d4c-40a7-a494-7c9f031fa8e8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Industry UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"industryId"}]}},"response":[{"id":"429d0c95-2723-43ee-8ece-070646e155df","name":"Get Specific Industry","originalRequest":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/industries/759e406b-36ca-430f-8bc9-5ebe08cd8755"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"759e406b-36ca-430f-8bc9-5ebe08cd8755\",\n \"name\": \"Administration\",\n \"createdAt\": \"2021-08-23T09:25:32.000Z\",\n \"updatedAt\": \"2021-08-23T09:25:32.000Z\"\n}"}],"_postman_id":"5d78532e-6c37-42e6-811d-877ee9be113c"},{"name":"Update Industry","id":"86b0ab14-64a7-4da8-b731-e65d8bce501d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"","description":"String | New name
\n","type":"text"}]},"url":"https://api.documo.com/identity/v2/industries/:industryId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Industry UUID
\n","type":"text/plain"},"type":"any","value":"","key":"industryId"}]}},"response":[{"id":"2f22a084-c50e-4ef6-8957-9ce3272f462b","name":"Update Industry","originalRequest":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/industries/759e406b-36ca-430f-8bc9-5ebe08cd8755"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"759e406b-36ca-430f-8bc9-5ebe08cd8755\",\n \"name\": \"Administration\",\n \"createdAt\": \"2021-08-23T09:25:32.000Z\",\n \"updatedAt\": \"2021-08-23T09:25:32.000Z\"\n}"}],"_postman_id":"86b0ab14-64a7-4da8-b731-e65d8bce501d"},{"name":"Delete Industry","id":"8226116e-d94a-4a10-b6ef-fad629ca0cfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/identity/v2/industries/:industryId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Industry UUID
\n","type":"text/plain"},"type":"any","value":"","key":"industryId"}]}},"response":[{"id":"aec5b58d-3d18-4691-bdc8-922cfd075ec4","name":"Delete Industry","originalRequest":{"method":"GET","header":[],"url":"https://api.documo.com/identity/v2/industries/759e406b-36ca-430f-8bc9-5ebe08cd8755"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"759e406b-36ca-430f-8bc9-5ebe08cd8755\",\n \"name\": \"Administration\",\n \"createdAt\": \"2021-08-23T09:25:32.000Z\",\n \"updatedAt\": \"2021-08-23T09:25:32.000Z\"\n}"}],"_postman_id":"8226116e-d94a-4a10-b6ef-fad629ca0cfc"}],"id":"0f59b44d-4624-48b8-9fbf-b556de8bf8a2","_postman_id":"0f59b44d-4624-48b8-9fbf-b556de8bf8a2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Returns a list of all API Keys
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"3dbbb6d9-42da-4650-88bf-17e2f0a651c5"},{"name":"Delete API Key","id":"9438a7b2-f58a-4e3e-b773-1c9ceda397e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/identity/v2/api-keys/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"48999136-271c-4e5e-bd66-a4e48dd87f1e","name":"Delete API Key","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.documo.com/identity/v2/api-keys/:id","host":["https://api.documo.com"],"path":["identity","v2","api-keys",":id"],"variable":[{"key":"id","value":"","description":"String | Required | UUID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9438a7b2-f58a-4e3e-b773-1c9ceda397e2"},{"name":"Delete Expired API key","id":"f8c1f425-d30f-4362-9b96-443bc4a0e352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/identity/v2/api-keys/expired","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"number | account
\n","type":"text/plain"},"type":"any","value":null,"key":"type"},{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"targetId"}]}},"response":[],"_postman_id":"7724c9ba-b1f9-4e9b-99d2-4135b2944717"},{"name":"Update FTP Config","id":"1449a049-bdf2-48c1-af79-824017487b09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.documo.com/ftp/v2/config/:type/:targetId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"number | account
\n","type":"text/plain"},"type":"any","value":null,"key":"type"},{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"targetId"}]}},"response":[],"_postman_id":"1449a049-bdf2-48c1-af79-824017487b09"},{"name":"Remove FTP Config","id":"751bd4c2-03cb-43f4-bf21-3d99f1340944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/ftp/v2/config/:type/:targetId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"number | account
\n","type":"text/plain"},"type":"any","value":null,"key":"type"},{"description":{"content":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"targetId"}]}},"response":[],"_postman_id":"751bd4c2-03cb-43f4-bf21-3d99f1340944"},{"name":"Display FTP Number Config","id":"503e09ab-5245-4929-a140-20815039040c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ftp/v2/config/number/:numberId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"}]}},"response":[],"_postman_id":"503e09ab-5245-4929-a140-20815039040c"},{"name":"Update FTP Number Config","id":"d6a4d6f2-97af-44d0-a779-56da043e05f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.documo.com/ftp/v2/config/number/:numberId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"}]}},"response":[],"_postman_id":"d6a4d6f2-97af-44d0-a779-56da043e05f0"},{"name":"Remove FTP Number Config","id":"093b8071-e93c-44f7-9251-480ba41988a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/ftp/v2/config/number/:numberId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"}]}},"response":[],"_postman_id":"093b8071-e93c-44f7-9251-480ba41988a8"},{"name":"Pull Account FTP Configuration","id":"e819d1e7-e551-4f56-aca8-736a793fc9eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ftp/v2/config/account/:accountId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"fec3eb3e-c327-45fe-b491-ed972684c2ce","name":"Pull FTP Configuration","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ftp/v2/config/account/:accountId","host":["https://api.documo.com"],"path":["ftp","v2","config","account",":accountId"],"variable":[{"key":"accountId","value":"","description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"8126fd22-ed4d-4897-b6a5-7e2afbd2a598\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"faxNumberId\": null,\n \"protocol\": \"ftp\",\n \"host\": \"192.168.0.1\",\n \"port\": 21,\n \"user\": \"mt\",\n \"outputDirPath\": \"files/\",\n \"notificationEmails\": null,\n \"createdAt\": \"2023-07-17T18:04:43.000Z\",\n \"updatedAt\": \"2023-07-17T18:05:07.000Z\",\n \"password\": \"Password123\"\n}"}],"_postman_id":"e819d1e7-e551-4f56-aca8-736a793fc9eb"},{"name":"Update Account FTP Configuration","id":"e9c4e96b-7f57-40cc-be93-cb4f72866e63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"protocol","value":"ftp","description":"ftp | sftp | disabled
\n","type":"text"},{"key":"host","value":"ftp.example.com","description":"Host of FTP server
\n","type":"text"},{"key":"port","value":"21","description":"Port number of the FTP server
\n","type":"text"},{"key":"user","value":"username","description":"Username for authentication
\n","type":"text"},{"key":"password","value":"Password123","description":"Password for authentication
\n","type":"text"},{"key":"outputDirPath","value":"/path/to/directory","description":"The output directory path on the FTP server
\n","type":"text"},{"key":"notificationEmails","value":"john.doe@documo.com","description":"An array of email addresses for notifications
\n","type":"text"},{"key":"createdAt","value":"2023-08-14T12:00:00Z","description":"Timestamp when created
\n","type":"text"},{"key":"updatedAt","value":"2023-08-14T12:00:00Z","description":"Timestamp when last updated
\n","type":"text"}]},"url":"https://api.documo.com/ftp/v2/config/account/:accountId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[],"_postman_id":"e9c4e96b-7f57-40cc-be93-cb4f72866e63"},{"name":"Remove Account FTP Configuration","id":"69154acf-aa75-40cc-be41-e2f6a2db7c81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/ftp/v2/config/account/:accountId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"accountId"}]}},"response":[],"_postman_id":"69154acf-aa75-40cc-be41-e2f6a2db7c81"}],"id":"c01458a8-72fd-488c-8c6e-eb951750f765","_postman_id":"c01458a8-72fd-488c-8c6e-eb951750f765","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6a96b2e6-7b45-4f5e-a3c2-ba8af48c9808","name":"Approve FMC Order","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"https://api.documo.com/next/fax/v2/faxbridges/orders/:id/approve","host":["https://api.documo.com"],"path":["next","fax","v2","faxbridges","orders",":id","approve"],"variable":[{"key":"id","value":"7bcfe3e6-709f-49a7-9da4-beefe7b2649c","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"quantity\": 1,\n \"createdAt\": \"2022-08-09T13:56:38.000Z\",\n \"updatedAt\": \"2025-11-18T18:47:13.000Z\",\n \"id\": \"0c2f9a72-34c0-4674-bc67-80bd9ca54545\",\n \"number\": \"fo_23240\",\n \"invoiceNumber\": null,\n \"accountId\": \"9919d68e-7b1f-4447-8286-a53260c50763\",\n \"status\": \"ordered\",\n \"cancellationReason\": null,\n \"price\": null,\n \"shippingPrice\": null,\n \"shippingAddress\": \"Line 1 Line 2 Podgorica Bla 81000 \",\n \"shippingAddress1\": null,\n \"shippingAddress2\": null,\n \"shippingCity\": null,\n \"shippingState\": null,\n \"shippingPostalCode\": null,\n \"shippingCountry\": null,\n \"shippingOption\": null,\n \"trackingId\": null,\n \"contactEmail\": \"admin@subaccount.com\",\n \"contactPhone\": \"+19092345675\",\n \"contactName\": \"Admin Subaccount\",\n \"companyName\": \"Demo Subaccount\",\n \"notes\": \"Some additional information\",\n \"approvedBy\": \"c16055d8-4097-485c-93cd-3e87972687c7\",\n \"approvedAt\": \"2022-08-22T10:58:29.000Z\",\n \"faxbridges\": []\n }\n}"}],"_postman_id":"124d2b6a-bd02-48b1-8adb-12b83eba56d7"},{"name":"Cancel FMC Order","id":"0dec1060-427b-4375-83da-cfca26e85bd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.documo.com/fax/v2/faxbridges/orders/:id/cancel","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"99600e0c-cfc8-4935-b387-a0d8af24986e","name":"Cancel FMC Order","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cancellationReason\":\"The reason for the cancellation\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/fax/v2/faxbridges/orders/:id/cancel","host":["https://api.documo.com"],"path":["fax","v2","faxbridges","orders",":id","cancel"],"variable":[{"key":"id","value":"8f6ccdfe-b443-4d56-9d42-633907631b2a","description":"String | Required | UUID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"quantity\": 1,\n \"createdAt\": \"2022-08-09T13:56:38.000Z\",\n \"updatedAt\": \"2025-11-18T18:47:13.000Z\",\n \"id\": \"0c2f9a72-34c0-4674-bc67-80bd9ca54545\",\n \"number\": \"fo_23240\",\n \"invoiceNumber\": null,\n \"accountId\": \"9919d68e-7b1f-4447-8286-a53260c50763\",\n \"status\": \"cancelled\",\n \"cancellationReason\": \"The reason for cancellation\",\n \"price\": null,\n \"shippingPrice\": null,\n \"shippingAddress\": \"Line 1 Line 2 Podgorica Bla 81000 \",\n \"shippingAddress1\": null,\n \"shippingAddress2\": null,\n \"shippingCity\": null,\n \"shippingState\": null,\n \"shippingPostalCode\": null,\n \"shippingCountry\": null,\n \"shippingOption\": null,\n \"trackingId\": null,\n \"contactEmail\": \"admin@subaccount.com\",\n \"contactPhone\": \"+19092345675\",\n \"contactName\": \"Admin Subaccount\",\n \"companyName\": \"Demo Subaccount\",\n \"notes\": \"Some additional information\",\n \"approvedBy\": \"c16055d8-4097-485c-93cd-3e87972687c7\",\n \"approvedAt\": \"2022-08-22T10:58:29.000Z\",\n \"faxbridges\": []\n }\n}"}],"_postman_id":"0dec1060-427b-4375-83da-cfca26e85bd2"},{"name":"Create FMC Order","id":"cc11fff7-7ee8-4cc0-a57f-5142d6d7166d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.documo.com/fax/v2/faxbridges/orders/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"72319201-8a5d-48d0-8349-710e4c11c2b9","name":"Get FMC Order","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/faxbridges/orders/:id","host":["https://api.documo.com"],"path":["fax","v2","faxbridges","orders",":id"],"variable":[{"key":"id","value":"a7b16d31-a105-4558-9bc3-4ae731af8c96","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"quantity\": 1,\n \"createdAt\": \"2022-08-09T13:56:38.000Z\",\n \"updatedAt\": \"2025-11-18T18:47:13.000Z\",\n \"id\": \"0c2f9a72-34c0-4674-bc67-80bd9ca54629\",\n \"number\": \"fo_23240\",\n \"invoiceNumber\": null,\n \"accountId\": \"9919d68e-7b1f-4447-8286-a53260c50763\",\n \"status\": \"cancelled\",\n \"cancellationReason\": \"The reason for cancellation\",\n \"price\": null,\n \"shippingPrice\": null,\n \"shippingAddress\": \"Line 1 Line 2 Podgorica Bla 81000 \",\n \"shippingAddress1\": null,\n \"shippingAddress2\": null,\n \"shippingCity\": null,\n \"shippingState\": null,\n \"shippingPostalCode\": null,\n \"shippingCountry\": null,\n \"shippingOption\": null,\n \"trackingId\": null,\n \"contactEmail\": \"admin@subaccount.com\",\n \"contactPhone\": \"+19092345675\",\n \"contactName\": \"Admin Subaccount\",\n \"companyName\": \"Demo Subaccount\",\n \"notes\": \"Some additional information\",\n \"approvedBy\": \"c16055d8-4097-485c-93cd-3e87972687c7\",\n \"approvedAt\": \"2022-08-22T10:58:29.000Z\",\n \"faxbridges\": []\n }\n}"}],"_postman_id":"4938b042-00df-4b8d-8c12-4ec2d19a6cfd"},{"name":"Get FMC Orders","id":"614a95d9-db47-4184-8bff-8c80609237de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.documo.com/fax/v2/faxbridges/orders/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Workspace ID | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"workspaceId"},{"description":{"content":"Workspace Document ID | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"wsDocId"}]}},"response":[{"id":"d751f3cd-f100-4e9f-ab68-d4d5ebc499cc","name":"Pull OCR data for workspace document","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ocr/v2/workspaces/:workspaceId/documents/:wsDocId","host":["https://api.documo.com"],"path":["ocr","v2","workspaces",":workspaceId","documents",":wsDocId"],"variable":[{"key":"workspaceId","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","description":"Workspace ID | UUID"},{"key":"wsDocId","value":"68539c8b-79d3-4fdb-a061-8fc0218c25c2","description":"Workspace Document ID | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.24.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"806"},{"key":"ETag","value":"W/\"326-ArFa09pbRHBE3+1IXmSs4Rqo120\""},{"key":"Date","value":"Wed, 22 Jan 2025 13:16:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"00000000-3142-4366-aae7-462742eeb971\",\n \"accountId\": \"00000000-d9a0-493f-a3aa-0cb1114eea0c\",\n \"wsDocId\": \"68539c8b-79d3-4fdb-a061-8fc0218c25c2\",\n \"status\": \"success\",\n \"pdfStatus\": \"success\",\n \"pagesCount\": 1,\n \"createdAt\": \"2025-01-16T14:25:21.574Z\",\n \"completedAt\": \"2025-01-16T14:25:25.510Z\",\n \"ocrData\": {\n \"text\": \"Test PDF\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Cras orci est, consectetur\\nquis sem commodo, ultricies eleifend leo. Phasellus ac purus quis risus egestas\\ndignissim. Aenean eros dui, lacinia in tortor pretium, viverra ultrices eros. Mauris\\nmalesuada leo in ante imperdiet, in porttitor lectus mollis. Sed pellentesque mauris\\nnulla, vel ultricies nibh laoreet feugiat. Aliquam rhoncus quam sed nunc mollis porta.\\nUt egestas elit enim, eu lacinia lectus sagittis in.\\n\"\n }\n}"}],"_postman_id":"19945999-fe6a-499d-a287-685b1cf5dc8b"},{"name":"Run OCR for workspace document","id":"4de88f52-81bc-4bcf-ad3e-2fd0581ea9cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":"https://api.documo.com/ocr/v2/workspaces/:workspaceId/documents/:wsDocId/trigger","urlObject":{"path":["ocr","v2","workspaces",":workspaceId","documents",":wsDocId","trigger"],"host":["https://api.documo.com"],"query":[],"variable":[{"description":{"content":"Workspace ID | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"workspaceId"},{"description":{"content":"Workspace Document ID | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"wsDocId"}]}},"response":[{"id":"bc20e213-8280-4c3b-9e25-8b20bfab7e9b","name":"Run OCR for workspace document","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":{"raw":"https://api.documo.com/ocr/v2/workspaces/:workspaceId/documents/:wsDocId/trigger","host":["https://api.documo.com"],"path":["ocr","v2","workspaces",":workspaceId","documents",":wsDocId","trigger"],"variable":[{"key":"workspaceId","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","description":"Workspace ID | UUID"},{"key":"wsDocId","value":"58541bda-7723-4adf-ad14-8c2288e684ae","description":"Workspace Document ID | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.24.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Date","value":"Wed, 22 Jan 2025 13:28:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4de88f52-81bc-4bcf-ad3e-2fd0581ea9cd"}],"id":"55a80089-0945-403b-865a-7157d81dd4e8","description":"The feature is currently in beta testing, and not available to all users. Additional adjustments to the endpoints may still occur.
\n","_postman_id":"55a80089-0945-403b-865a-7157d81dd4e8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Returns a list of all faxes in Cold Storage
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required |UUID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Required | Date
\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"String | Required | Date
\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"String | Required | Fax direction - inbound, outbound
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"String | Required | Fax status - all, failed, success
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"String | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"String | Default: 50 | Minimum: 5 | Maximum 500 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Boolean | Default: false
\n","type":"text/plain"},"key":"withChildren","value":""}],"variable":[]}},"response":[{"id":"f52ab4c8-88dc-4a6d-be85-0d78878efafb","name":"All Cold Storage","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/cold-storage?accountId=efaa36f7-d9a0-493f-a3aa-0cb1114eea0d&startDate=01-01-2024&endDate=12-12-2024&direction=outbound&status=success","host":["https://api.documo.com"],"path":["fax","v2","cold-storage"],"query":[{"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0d","description":"String | Required |UUID"},{"key":"startDate","value":"01-01-2024","description":"String | Required | Date"},{"key":"endDate","value":"12-12-2024","description":"String | Required | Date"},{"key":"direction","value":"outbound","description":"String | Required | Fax direction - inbound, outbound"},{"key":"status","value":"success","description":"String | Required | Fax status - all, failed, success"},{"key":"offset","value":"","description":"String | Default: 0 | Number of results to skip (used for pagination)","disabled":true},{"key":"limit","value":"","description":"String | Default: 50 | Minimum: 5 | Maximum 500 | Number of results to be returned (used for pagination)","disabled":true},{"key":"withChildren","value":null,"description":"Boolean | Default: false","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.13.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"170"},{"key":"X-RateLimit-Reset","value":"3"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"443"},{"key":"ETag","value":"W/\"1bb-37KjYQaOjks4OH7JCFXon7zjuVE\""},{"key":"Date","value":"Wed, 26 Jun 2024 20:53:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"00dbd599-abee-4221-bd63-f23fc1aac2dc\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0d\",\n \"direction\": \"outbound\",\n \"channelType\": \"web\",\n \"status\": \"success\",\n \"pagesComplete\": 80,\n \"faxNumber\": \"60\",\n \"faxSenderCsid\": null,\n \"faxReceiverCsid\": null,\n \"faxCallerId\": \"9040\",\n \"deviceId\": \"+1721872663 \",\n \"faxBridgeId\": \"invoice\",\n \"metadata\": 192984594,\n \"resolvedAt\": \"2024-06-26T16:42:31.000Z\"\n }\n]"}],"_postman_id":"a8e859f5-6022-4248-a4a1-bbbcc969c812"},{"name":"Cold Storage for One Fax","id":"58ff4fd8-7d73-4202-8e57-53b5d6b821ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/cold-storage/:id","description":"Returns details about a fax in Cold Storage
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | UUID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d6b8a931-85bb-4742-a18b-e534de912b77","name":"Cold Storage for One Fax","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/cold-storage/:id","host":["https://api.documo.com"],"path":["fax","v2","cold-storage",":id"],"variable":[{"key":"id","value":"00dbd599-abee-4221-bd63-f23fc1aac2dc","description":"String | Required | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.13.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"178"},{"key":"X-RateLimit-Reset","value":"17"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"441"},{"key":"ETag","value":"W/\"1b9-hZGMNekWj0vlgDpXdOxSFY6FDtU\""},{"key":"Date","value":"Wed, 26 Jun 2024 20:44:30 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"00dbd599-abee-4221-bd63-f23fc1aac2dc\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0d\",\n \"direction\": \"outbound\",\n \"channelType\": \"web\",\n \"status\": \"success\",\n \"pagesComplete\": 80,\n \"faxNumber\": \"60\",\n \"faxSenderCsid\": null,\n \"faxReceiverCsid\": null,\n \"faxCallerId\": \"9040\",\n \"deviceId\": \"+1721872663 \",\n \"faxBridgeId\": \"invoice\",\n \"metadata\": 192984594,\n \"resolvedAt\": \"2024-06-26T16:42:31.000Z\"\n}"}],"_postman_id":"58ff4fd8-7d73-4202-8e57-53b5d6b821ca"},{"name":"Export Cold Storage","id":"d4636812-e62b-4884-98f6-589d4b70026c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/fax/v2/cold-storage/export","description":"Exports a list of faxes in Cold Storage as CSV
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required |UUID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Required | Date
\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"String | Required | Date
\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"String | Required | Fax direction - inbound, outbound
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"String | Required | Fax status - failed, success
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"String | Default: 50 | Minimum: 50 | Maximum 15000 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Boolean | Default: false
\n","type":"text/plain"},"key":"withChildren","value":""}],"variable":[]}},"response":[{"id":"95dfd379-c608-4273-884a-a6af10c6f9ce","name":"Export Cold Storage","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/fax/v2/cold-storage/export?accountId=efaa36f7-d9a0-493f-a3aa-0cb1114eea0d&startDate=01-01-2024&endDate=12-12-2024&direction=outbound&status=success&limit=50","host":["https://api.documo.com"],"path":["fax","v2","cold-storage","export"],"query":[{"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0d","description":"String | Required |UUID"},{"key":"startDate","value":"01-01-2024","description":"String | Required | Date"},{"key":"endDate","value":"12-12-2024","description":"String | Required | Date"},{"key":"direction","value":"outbound","description":"String | Required | Fax direction - inbound, outbound"},{"key":"status","value":"success","description":"String | Required | Fax status - failed, success"},{"key":"limit","value":"50","description":"String | Required | Default: 50 | Minimum: 50 | Maximum 15000 | Number of results to be returned (used for pagination)"},{"key":"withChildren","value":"","description":"Boolean | Default: false","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.13.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"178"},{"key":"X-RateLimit-Reset","value":"44"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"443"},{"key":"ETag","value":"W/\"1bb-37KjYQaOjks4OH7JCFXon7zjuVE\""},{"key":"Date","value":"Wed, 26 Jun 2024 20:48:41 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"\"id\",\"accountId\",\"direction\",\"channelType\",\"status\",\"pagesComplete\",\"faxNumber\",\"faxSenderCsid\",\"faxReceiverCsid\",\"faxCallerId\",\"deviceId\",\"faxBridgeId\",\"vendor\",\"metadata\",\"resolvedAt\"\n\"00dbd599-abee-4221-bd63-f23fc1aac2dc\",\"efaa36f7-d9a0-493f-a3aa-0cb1114eea0d\",\"outbound\",\"web\",\"success\",80,\"60\",,,\"9040\",\"+1721872663 \",\"invoice\",192984594,\"2024-06-26T16:42:31.000Z\""}],"_postman_id":"d4636812-e62b-4884-98f6-589d4b70026c"}],"id":"24688824-7342-4fe1-852f-f24709b68d62","_postman_id":"24688824-7342-4fe1-852f-f24709b68d62","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Optional | Search Query
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"Uuid | Optional | Slug of parent folder
\n","type":"text/plain"},"key":"folderId","value":""},{"disabled":true,"description":{"content":"Integer | Optional | Number of results to be returned
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Integer | Optional | Number of results to skip
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Enum | Optional | Order values
\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"e8c68508-de5a-49c7-a2c7-a96d4a1353a1"},{"name":"Download File","id":"e1e82a4c-bffd-48d6-bcec-db4da5761df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/drive/v2/files/:file_id/download","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Uuid | Required | Slug of target resource
\n","type":"text/plain"},"type":"any","value":"","key":"file_id"}]}},"response":[],"_postman_id":"e1e82a4c-bffd-48d6-bcec-db4da5761df4"},{"name":"Upload file","id":"28f2962c-295e-4667-bdfe-860c9c366f80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","description":"File | Required | Files to be uploaded
\n","type":"file","value":null},{"key":"folderId","value":"","description":"Uuid | Optional | Slug of parent folder
\n","type":"text"},{"key":"sharedWithAccount","value":"","description":"Boolean | Setting this to ‘true’ will make this folder accessible by users across the account
\n","type":"text"},{"key":"isPublic","value":"","description":"Boolean | Optional | Set to 'true' if you want file to be public
\n","type":"text"}]},"url":"https://api.documo.com/drive/v2/files","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Optional | Folder name
\n","type":"text"}]},"url":"https://api.documo.com/drive/v2/files/:file_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Uuid | Required | Single or comma separated slug(s) of target files
\n","type":"text"}]},"url":"https://api.documo.com/drive/v2/files","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Optional | Search Query
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"Uuid | Optional | Slug of parent folder
\n","type":"text/plain"},"key":"parentId","value":""},{"disabled":true,"description":{"content":"Integer | Optional | Number of results to be returned
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Integer | Optional | Number of results to skip
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Enum | Optional | Order values
\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"c98a2977-8484-4754-a840-54532d756755"},{"name":"List Shared Folders","id":"9081c90d-018d-4f81-8cb7-af8cc81873d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/drive/v2/folders/shared","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Optional | Search Query
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"Uuid | Optional | Folder slug
\n","type":"text/plain"},"key":"parentId","value":""},{"disabled":true,"description":{"content":"Integer | Optional | Number of results to be returned
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Integer | Optional | Number of results to skip
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"9081c90d-018d-4f81-8cb7-af8cc81873d8"},{"name":"List Folder Info","id":"47569213-efa8-4dcb-b542-087b8ac3df02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/drive/v2/folders/:folder_id/info","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Uuid | Required | Slug of target resource
\n","type":"text/plain"},"type":"any","value":"","key":"folder_id"}]}},"response":[],"_postman_id":"47569213-efa8-4dcb-b542-087b8ac3df02"},{"name":"Create Folder","id":"a4a6f924-c747-474a-a9fc-aeb7d3ffdf17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"","description":"String | Required | Folder name
\n","type":"text","disabled":true},{"key":"parentId","value":"","description":"Uuid | Optional | Slug of parent folder
\n","type":"text","disabled":true},{"key":"sharedWithAccount","value":"","description":"Boolean | Setting this to ‘true’ will make this folder accessible by users across the account
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/drive/v2/folders","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Optional | Folder name
\n","type":"text"}]},"url":"https://api.documo.com/drive/v2/folders/:folder_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Uuid | Required | Comma separated list of target folder slugs
\n","type":"text"}]},"url":"https://api.documo.com/drive/v2/folders","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Fetches a paginated list of existing workspaces for a given account.
\nQuery Parameters
\naccountId (string, optional) – Filter workspaces by a specific account.
query (string, optional) – Search workspaces by name.
limit (integer, optional, default: 10) – Maximum number of results to return.
offset (integer, optional, default: 0) – Number of results to skip before returning workspaces.
Request Body
\nStatus Codes
\n200 OK – Successfully retrieved the list of workspaces.
404 Not Found – No workspaces found for the given account.
Body (JSON array)
\nEach workspace object contains the following fields:
\nid (string) – Unique identifier of the workspace.
accountId (string) – Identifier of the account the workspace belongs to.
name (string) – Name of the workspace.
createdAt (string, ISO 8601) – Timestamp when the workspace was created.
updatedAt (string, ISO 8601) – Timestamp when the workspace was last updated.
deletedAt (string|null) – Timestamp if the workspace has been deleted.
String | Account ID to get the workspaces for
\n","type":"text/plain"},"key":"accountId","value":"00000000-0000-0000-0000-000000000000"},{"disabled":true,"description":{"content":"String | Search by Workspace name
\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"String | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"String | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"4951391a-b1c1-47cb-b1f3-091089950953","name":"List Workspaces","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2025-07-31T00:00:00.000Z\",\n \"updatedAt\": \"2025-07-31T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"accountId\": \"10000000-0000-0000-0000-000000000001\",\n \"name\": \"Workspace 1\",\n \"deletedAt\": null\n },\n {\n \"createdAt\": \"2025-07-31T00:00:00.000Z\",\n \"updatedAt\": \"2025-07-31T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"accountId\": \"10000000-0000-0000-0000-000000000001\",\n \"name\": \"Workspace 2\",\n \"deletedAt\": null\n },\n {\n \"createdAt\": \"2025-07-31T00:00:00.000Z\",\n \"updatedAt\": \"2025-07-31T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000003\",\n \"accountId\": \"10000000-0000-0000-0000-000000000001\",\n \"name\": \"Workspace 3\",\n \"deletedAt\": null\n },\n {\n \"createdAt\": \"2025-07-31T00:00:00.000Z\",\n \"updatedAt\": \"2025-07-31T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000004\",\n \"accountId\": \"10000000-0000-0000-0000-000000000001\",\n \"name\": \"Workspace 4\",\n \"deletedAt\": null\n },\n {\n \"createdAt\": \"2025-07-31T00:00:00.000Z\",\n \"updatedAt\": \"2025-07-31T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000005\",\n \"accountId\": \"10000000-0000-0000-0000-000000000001\",\n \"name\": \"Workspace 5\",\n \"deletedAt\": null\n }\n]"}],"_postman_id":"72c04e92-c01a-4a00-944f-8a0dbfbc70ae"},{"name":"Create Workspace","id":"0defc281-7cfb-4328-9a08-54ff5dae88bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Testing Workspace API\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea09\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.documo.com/ws/v2/workspaces","description":"This API endpoint allows you to create a new workspace.
\nname: (string) The name of the workspace.
accountId: (string) The ID of the account to which the workspace belongs.
Upon successful creation, the API returns a status code of 201 and a JSON object
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This endpoint allows you to add a user to a specific workspace.
\nMethod: PUT
\nBody should include user role: user | admin | owner
eg: { \"role\": \"user\" }
\nUUID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"workspaceId"},{"description":{"content":"UUID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"userId"}]}},"response":[{"id":"176f9f5a-0fcb-4d75-bb05-f5b3e2e40607","name":"New Request","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"This endpoint allows the addition of a new source number to the specified workspace.
\nRequest Body
\nsourceType (string): The type of the source to be added. This is currently limited to only \"inbound_fax\".
sourceId (string): The unique identifier of the source to be added.
Response
\ncreatedAt (string): The timestamp when the source was created.
updatedAt (string): The timestamp when the source was last updated.
workspaceId (string): The ID of the workspace to which the source was added.
enabled (boolean): Indicates if the source is enabled.
sourceType (string): The type of the added source.
sourceId (string): The unique identifier of the added source.
criteria (null): Criteria for the added source (if applicable).
id (string): The ID of the added source.
UUID
\n","type":"text/plain"},"type":"any","value":"86752f96-1132-4f22-93b9-5d54103efec0","key":"workspaceId"}]}},"response":[{"id":"477f4a10-4a7d-40c5-b4c0-26ff6d1f9f7b","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"File name
\n","type":"text"},{"key":"file","description":"File
\n","type":"file","src":"postman-cloud:///1efd7ef6-449f-49e0-b88c-a5c01a5fb824"}]},"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/upload","description":"Allows a user to upload a document to a specific workspace. The request must include the file to upload along with its metadata.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the workspace where the document will be uploaded.Request Body (multipart/form-data)
\nname (string, required) – Name of the file being uploaded.
file (file, required) – The document file to upload.
Status Codes
\n201 Created – The document was successfully uploaded.
400 Bad Request – Invalid input or missing file.
404 Not Found – The specified workspace could not be found.
Body (JSON object)
\nReturns metadata for the uploaded document:
\nid (string) – Unique identifier of the document.
workspaceId (string) – Identifier of the target workspace the document belongs to.
name (string) – Name of the document.
createdAt (string, ISO 8601) – Timestamp when the document was originally created.
addedAt (string, ISO 8601) – Timestamp when the document was added to the workspace.
statusId (string|null) – Reference to the document’s status (if any).
typeId (string|null) – Reference to the document’s type (if any).
sourceType (string) – The source of the document (e.g., \"upload\", \"fax\").
sourceId (string) – Unique identifier of the source that provided the document.
from (string|null) – Starting point of the document (e.g., fax sender).
to (string|null) – Ending point of the document (e.g., fax recipient).
pagesCount (integer) – Number of pages in the document.
isUploading (boolean) – Indicates if the document is currently uploading.
deletedAt (string|null) – Timestamp if the document has been deleted.
This HTTP DELETE request is used to delete a specific workspace identified by the workspaceId in the URL path. The request does not contain a request body.
Status: 204
\nContent-Type: text/xml
\nBody: null
\nThis HTTP PATCH request is used to update the settings for a specific workspace. The request should be made where :workspaceId is the identifier of the workspace being updated.
\nThe request body should include one or both of the following parameters:
\nocrEnabled (boolean): Indicates whether OCR is enabled for the workspace.
ocrToPdfEnabled (boolean): Indicates whether OCR to PDF conversion is enabled for the workspace.
Upon a successful execution of the request, the API will return a 200 status code
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Retrieves a paginated list of documents within a given workspace.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the workspace to fetch documents from.Query String Parameters
\nquery (string, optional) – Filter documents by document name.
includeCount (boolean, optional) – If true, includes the total count of records within the workspace in response headers.
limit (integer, optional) – Maximum number of results to return (for pagination).
offset (integer, optional) – Number of results to skip before returning documents (for pagination).
Headers
\nX-Next-Page-Available (boolean) – Indicates if more results are available beyond the current page.
X-Total-Count (integer) – Total number of documents matching the query. Returned only if includeCount=true.
Body (array of objects)
\nEach document has the following fields:
\nid (string) – Unique identifier of the document.
name (string) – Name of the document (e.g., \"Test\").
workspaceId (string) – Identifier of the workspace the document belongs to.
createdAt (string, ISO 8601) – Timestamp when the document was created or last updated.
addedAt (string, ISO 8601) – Timestamp when the document was added to the workspace.
isUploading (boolean) – Indicates if the document is still being uploaded (false = upload complete).
pagesCount (integer|null) – Number of pages in the document.
from (string|null) – Originator of the document (e.g., fax sender).
to (string|null) – Destination of the document (e.g., fax recipient).
sourceType (string) – The origin of the document (e.g., \"upload\", \"fax\").
sourceId (string|null) – Unique identifier of the source that provided the document.
statusId (string|null) – Reference to the document’s current status.
typeId (string|null) – Reference to the document’s type (if any).
deletedAt (string|null) – Timestamp if the document was deleted, otherwise null.
status (object|null) – Current status of the document
id (string) – Unique identifier of the status.
workspaceId (string) – Identifier of the workspace the status belongs to.
name (string) – Status name (e.g., \"New\", \"Opened\", \"In Progress\").
order (integer) – Display order of the status.
createdAt (string, ISO 8601) – When the status was created.
updatedAt (string, ISO 8601) – When the status was last updated.
type (object|null) – Metadata for the assigned document type
id (string) – Unique identifier of the document type.
name (string) – Name of the document type.
locked (boolean) – If true, the document type cannot be modified or deleted.
accountId (string) – Account associated with this document type.
createdAt (string, ISO 8601) – Timestamp when the type was created.
updatedAt (string, ISO 8601) – Timestamp when the type was last updated.
deletedAt (string|null) – Timestamp if the type was deleted, otherwise null.
patient (object, optional) – Associated patient metadata (for medical/EHR use cases):
id (string) – Patient identifier.
firstName (string) – Patient first name.
lastName (string) – Patient last name.
dateOfBirth (string, ISO 8601) – Patient date of birth.
referenceId (string) – External reference ID.
ehrPlatformId (string) – Identifier in the linked EHR platform.
String | Search by Document name
\n","type":"text/plain"},"key":"query","value":"smiley"},{"disabled":true,"description":{"content":"Boolean | Default: false | The count of records returned
\n","type":"text/plain"},"key":"includeCount","value":"true"},{"disabled":true,"description":{"content":"String | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"String | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"description":{"content":"UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"workspaceId"}]}},"response":[{"id":"2dc5edd5-72fe-4493-9be9-541f203d5e39","name":"Get Documents - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.36.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"178"},{"key":"X-RateLimit-Reset","value":"4"},{"key":"X-Next-Page-Available","value":"false"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2416"},{"key":"ETag","value":"W/\"970-nTliB9qEpQlTmyl631dE1x5w7lo\""},{"key":"Date","value":"Thu, 14 Aug 2025 11:39:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Document 1\",\n \"statusId\": \"00000000-0000-0000-0000-000000000000\",\n \"status\": {\n \"createdAt\": \"1990-01-01T00:00:00.000Z\",\n \"updatedAt\": \"1990-01-01T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Sent to EHR\",\n \"order\": 4\n },\n \"sourceType\": \"upload\",\n \"sourceId\": \"00000000-0000-0000-0000-000000000000\",\n \"from\": null,\n \"to\": null,\n \"typeId\": null,\n \"createdAt\": \"1990-01-01T00:00:00.000Z\",\n \"addedAt\": \"1990-01-01T00:00:00.000Z\",\n \"pagesCount\": 1,\n \"type\": null,\n \"patient\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"1990-01-01T00:00:00.000Z\",\n \"referenceId\": \"1\",\n \"ehrPlatformId\": \"00000000-0000-0000-0000-000000000000\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Document 2\",\n \"statusId\": \"00000000-0000-0000-0000-000000000000\",\n \"status\": {\n \"createdAt\": \"1990-01-01T00:00:00.000Z\",\n \"updatedAt\": \"1990-01-01T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Sent to EHR\",\n \"order\": 4\n },\n \"sourceType\": \"upload\",\n \"sourceId\": \"00000000-0000-0000-0000-000000000000\",\n \"from\": null,\n \"to\": null,\n \"typeId\": null,\n \"createdAt\": \"1990-01-01T00:00:00.000Z\",\n \"addedAt\": \"1990-01-01T00:00:00.000Z\",\n \"pagesCount\": 1,\n \"type\": null,\n \"patient\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"1990-01-01T00:00:00.000Z\",\n \"referenceId\": \"1\",\n \"ehrPlatformId\": \"00000000-0000-0000-0000-000000000000\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Document 3\",\n \"statusId\": \"00000000-0000-0000-0000-000000000000\",\n \"status\": {\n \"createdAt\": \"1990-01-01T00:00:00.000Z\",\n \"updatedAt\": \"1990-01-01T00:00:00.000Z\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Sent to EHR\",\n \"order\": 4\n },\n \"sourceType\": \"upload\",\n \"sourceId\": \"00000000-0000-0000-0000-000000000000\",\n \"from\": null,\n \"to\": null,\n \"typeId\": null,\n \"createdAt\": \"1990-01-01T00:00:00.000Z\",\n \"addedAt\": \"1990-01-01T00:00:00.000Z\",\n \"pagesCount\": 1,\n \"type\": null,\n \"patient\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"1990-01-01T00:00:00.000Z\",\n \"referenceId\": \"1\",\n \"ehrPlatformId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n]\n"},{"id":"87a5b2e8-059a-4aff-90ed-ee3f9c8546c1","name":"Get Documents - Validation failed (Route parameter)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspaceId","documents"],"query":[{"key":"query","value":"smiley","description":"String | Search by Document name","type":"text","disabled":true},{"key":"includeCount","value":"true","description":"Boolean | Default: false | The count of records returned","type":"text","disabled":true},{"key":"limit","value":"100","description":"String | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)","disabled":true},{"key":"offset","value":"0","description":"String | Default: 0 | Number of results to skip (used for pagination)","disabled":true}],"variable":[{"key":"workspaceId","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Validation failed (uuid is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"d5555e2f-77c4-42ef-8255-937cc158db49","name":"Get Documents - Workspace not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents?limit=100&offset=0","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspaceId","documents"],"query":[{"key":"query","value":"smiley","description":"String | Search by Document name","type":"text","disabled":true},{"key":"includeCount","value":"true","description":"Boolean | Default: false | The count of records returned","type":"text","disabled":true},{"key":"limit","value":"100","description":"String | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)"},{"key":"offset","value":"0","description":"String | Default: 0 | Number of results to skip (used for pagination)"}],"variable":[{"key":"workspaceId","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.36.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"70"},{"key":"ETag","value":"W/\"46-SU+/nXnICu8pjh4v48vqAYy5eo0\""},{"key":"Date","value":"Mon, 18 Aug 2025 15:16:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Workspace not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"}],"_postman_id":"cf689b22-e958-474d-a02a-323fab24004e"},{"name":"Get Document Info","id":"7f7aebe1-4017-46bc-9eb1-7910fc625c5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","description":"Retrieves JSON metadata about a specific document in a workspace without downloading the file itself.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the workspace the document belongs to.
document_id (string, required) – Unique identifier of the document to retrieve.
Request Body
\nStatus Codes
\n200 OK – Successfully retrieved document details.
400 Bad Request – Invalid parameters were provided.
404 Not Found – The specified document or workspace does not exist.
Body (JSON object)
\nReturns metadata for the requested document:
\nid (string) – Unique identifier of the document.
name (string) – Name of the document (e.g., \"Test\").
workspaceId (string) – Identifier of the workspace the document belongs to.
createdAt (string, ISO 8601) – Timestamp when the document was created or last updated.
addedAt (string, ISO 8601) – Timestamp when the document was added to the workspace.
isUploading (boolean) – Indicates if the document is still being uploaded (false = upload complete).
pagesCount (integer|null) – Number of pages in the document.
from (string|null) – Originator of the document (e.g., fax sender).
to (string|null) – Destination of the document (e.g., fax recipient).
sourceType (string) – The origin of the document (e.g., \"upload\", \"fax\").
sourceId (string|null) – Unique identifier of the source that provided the document.
statusId (string|null) – Reference to the document’s current status.
typeId (string|null) – Reference to the document’s type (if any).
deletedAt (string|null) – Timestamp if the document was deleted, otherwise null.
status (object|null) – Current status of the document
id (string) – Unique identifier of the status.
workspaceId (string) – Identifier of the workspace the status belongs to.
name (string) – Status name (e.g., \"New\", \"Opened\", \"In Progress\").
order (integer) – Display order of the status.
createdAt (string, ISO 8601) – When the status was created.
updatedAt (string, ISO 8601) – When the status was last updated.
workspace (object) – Metadata of the workspace the document belongs to
id (string) – Unique identifier of the workspace.
name (string) – Name of the workspace.
accountId (string) – Account associated with this document’s workspace.
createdAt (string, ISO 8601) – Timestamp when the workspace was created.
updatedAt (string, ISO 8601) – Timestamp when the workspace was last updated.
deletedAt (string|null) – Timestamp if the workspace was deleted, otherwise null.
type (object|null) – Metadata for the assigned document type
id (string) – Unique identifier of the document type.
name (string) – Name of the document type.
locked (boolean) – If true, the document type cannot be modified or deleted.
accountId (string) – Account associated with this document type.
createdAt (string, ISO 8601) – Timestamp when the type was created.
updatedAt (string, ISO 8601) – Timestamp when the type was last updated.
deletedAt (string|null) – Timestamp if the type was deleted, otherwise null.
UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"workspace_id"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"document_id"}]}},"response":[{"id":"d5704cb4-c392-40f4-9001-d0911d2f6d2d","name":"Get Document Info - OK","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"DK_upload1\",\n \"sourceType\": \"upload\", // \"upload\" | \"fax\" | \"email\"\n \"sourceId\": \"33333333-3333-3333-3333-333333333333\",\n \"from\": null,\n \"to\": null,\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"addedAt\": \"1970-01-01 00:00:00.000000\",\n \"pagesCount\": 1,\n \"typeId\": \"44444444-4444-4444-4444-444444444444\",\n \"statusId\": \"55555555-5555-5555-5555-555555555555\",\n \"isUploading\": false,\n \"workspace\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"name\": \"Workspace one\",\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\"\n },\n \"type\": {\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"id\": \"88888888-8888-8888-8888-888888888888\",\n \"name\": \"Admission form\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"locked\": false\n },\n \"status\": {\n \"createdAt\": \"2025-04-18T15:27:45.584Z\",\n \"updatedAt\": \"2025-04-18T15:27:45.584Z\",\n \"id\": \"55555555-5555-5555-5555-555555555555\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Opened\",\n \"order\": 2\n }\n }"},{"id":"3edd12cf-af60-409e-a2c8-a4d6ce78199b","name":"Get Document Info - Validation failed (Route parameter)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Validation failed (uuid is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"ad8900b7-200c-4a18-82e7-7ab6612eace2","name":"Get Document Info - Workspace not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Workspace not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"},{"id":"8c55f724-c6eb-4ca9-906f-4c53cbeda9c6","name":"Get Document Info - Document not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.36.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"69"},{"key":"ETag","value":"W/\"45-48QKxdxMDamPXgreE4jpUjuJ1Gg\""},{"key":"Date","value":"Mon, 18 Aug 2025 15:31:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"}],"_postman_id":"7f7aebe1-4017-46bc-9eb1-7910fc625c5d"},{"name":"Download Document","id":"aa57419f-fe27-4dec-95a7-c419ceb57eed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/download","description":"This endpoint downloads the binary content of a specific document from a workspace. It requires both the workspace ID and the document ID as path parameters.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the workspace the document belongs to.
document_id (string, required) – Unique identifier of the document to download.
Request Body
\nStatus Codes
\n200 OK – Returns the document file in binary form.
400 Bad Request – Invalid parameters were provided.
404 Not Found – Returned if either the workspace or the document does not exist or if the document is still in an uploading state and cannot be downloaded yet.
Headers
\nContent-Type – The MIME type of the file (typically application/pdf).
Content-Disposition – Defines how the content should be handled by the client (e.g., inline or as an attachment with filename).
Body
\nUUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"workspace_id"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"document_id"}]}},"response":[{"id":"6191236b-4b53-461a-8216-4e89db1a43d4","name":"Download Document - Validation failed (Route parameter)","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/download","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","download"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Validation failed (uuid is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"7bd78909-36c3-4023-afc9-93f51fe9d7fd","name":"Download Document - Workspace not found","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/download","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","download"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"code":404,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Workspace not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"},{"id":"5ce4b0fa-dccf-4a6c-8b2b-3d085bf0c0ec","name":"Download Document - Document not found","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/download","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","download"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"},{"id":"bae92173-34e9-40f6-999a-e3ec1c30ba19","name":"Download Document - Document is in uploading state","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/download","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","download"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.36.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"178"},{"key":"X-RateLimit-Reset","value":"49"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"81"},{"key":"ETag","value":"W/\"51-9WtWUsMway/FnSsWTeuQeBilwZw\""},{"key":"Date","value":"Mon, 18 Aug 2025 15:45:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document is in uploading state\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"}],"_postman_id":"aa57419f-fe27-4dec-95a7-c419ceb57eed"},{"name":"Split Document","id":"66121a56-601c-4d76-aa92-e0c1f14e5f0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"New Document\",\n \"pages\": [\"1\", \"2\", \"3\"],\n \"targetWorkspaceId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/split","description":"This endpoint splits document and creates new document in target workspace. It requires both the workspace ID and the document ID as path parameters.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the workspace the document belongs to.
document_id (string, required) – Unique identifier of the document to download.
Request Body
\nname (string, required) – Name of the new document
pages (string, required) – Pages indexes, 1-indexed, e.g., [\"1\", \"2\", \"3\"]
targetWorkspaceId (string, required) – Unique identifier of the destination workspace in which the new document should be created.
Status Codes
\n200 OK – The document was successfully moved to the target workspace.
400 Bad Request – Invalid request payload.
404 Not Found – The specified workspace or document could not be found or if the document is currently uploading and cannot be moved.
Body (JSON object)
\nReturns the updated details of the moved document:
\nid (string) – Unique identifier of the document.
name (string) – Name of the document (e.g., \"Test\").
workspaceId (string) – Identifier of the workspace the document belongs to.
createdAt (string, ISO 8601) – Timestamp when the document was created or last updated.
addedAt (string, ISO 8601) – Timestamp when the document was added to the workspace.
isUploading (boolean) – Indicates if the document is still being uploaded (false = upload complete).
pagesCount (integer|null) – Number of pages in the document.
from (string|null) – Originator of the document (e.g., fax sender).
to (string|null) – Destination of the document (e.g., fax recipient).
sourceType (string) – The origin of the document (e.g., \"upload\", \"fax\").
sourceId (string|null) – Unique identifier of the source that provided the document.
statusId (string|null) – Reference to the document’s current status.
typeId (string|null) – Reference to the document’s type (if any).
deletedAt (string|null) – Timestamp if the document was deleted, otherwise null.
UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"workspace_id"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"document_id"}]}},"response":[{"id":"b6f6d858-06c2-491c-8e33-ade2c14da5f8","name":"Split Document - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"New Document\",\n \"pages\": \"1,2,3\",\n \"targetWorkspaceId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/split","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","split"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"DK_upload1\",\n \"sourceType\": \"upload\", // \"upload\" | \"fax\" | \"email\"\n \"sourceId\": \"33333333-3333-3333-3333-333333333333\",\n \"from\": null,\n \"to\": null,\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"addedAt\": \"1970-01-01 00:00:00.000000\",\n \"pagesCount\": 1,\n \"typeId\": \"44444444-4444-4444-4444-444444444444\",\n \"statusId\": \"55555555-5555-5555-5555-555555555555\",\n \"isUploading\": false,\n \"workspace\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"name\": \"Workspace one\",\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\"\n },\n \"type\": {\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"id\": \"88888888-8888-8888-8888-888888888888\",\n \"name\": \"Admission form\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"locked\": false\n },\n \"status\": {\n \"createdAt\": \"2025-04-18T15:27:45.584Z\",\n \"updatedAt\": \"2025-04-18T15:27:45.584Z\",\n \"id\": \"55555555-5555-5555-5555-555555555555\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Opened\",\n \"order\": 2\n }\n }"},{"id":"bcac69e0-af26-4690-89bc-63a411b3056e","name":"Split Document - Validation failed (Route parameter)","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Document\",\n \"pages\": \"1,2,3\",\n \"targetWorkspaceId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/split","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","split"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Validation failed (uuid is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"e6ee1ff7-810d-4230-8231-283c55c1e15d","name":"Split Document - Workspace not found","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Document\",\n \"pages\": \"1,2,3\",\n \"targetWorkspaceId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/split","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","split"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"code":404,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Workspace not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"},{"id":"9fca1843-0cd5-42d9-9717-96d69e794f04","name":"Split Document - Document not found","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Document\",\n \"pages\": \"1,2,3\",\n \"targetWorkspaceId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/split","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id","split"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"}],"_postman_id":"66121a56-601c-4d76-aa92-e0c1f14e5f0a"},{"name":"Move Document","id":"105dec0e-bebd-49b9-816a-9ba6292a1e6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"targetWorkspaceId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId","description":"Moves a specific document from one workspace to another. The target workspace is specified in the request body.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the current workspace the document belongs to.
document_id (string, required) – Unique identifier of the document to move.
Request Body
\ntargetWorkspaceId (string, required) – Unique identifier of the destination workspace to which the document should be moved.Status Codes
\n200 OK – The document was successfully moved to the target workspace.
400 Bad Request – Invalid request payload.
404 Not Found – The specified workspace or document could not be found or if the document is currently uploading and cannot be moved.
Body (JSON object)
\nReturns the updated details of the moved document:
\nid (string) – Unique identifier of the document.
name (string) – Name of the document (e.g., \"Test\").
workspaceId (string) – Identifier of the workspace the document belongs to.
createdAt (string, ISO 8601) – Timestamp when the document was created or last updated.
addedAt (string, ISO 8601) – Timestamp when the document was added to the workspace.
isUploading (boolean) – Indicates if the document is still being uploaded (false = upload complete).
pagesCount (integer|null) – Number of pages in the document.
from (string|null) – Originator of the document (e.g., fax sender).
to (string|null) – Destination of the document (e.g., fax recipient).
sourceType (string) – The origin of the document (e.g., \"upload\", \"fax\").
sourceId (string|null) – Unique identifier of the source that provided the document.
statusId (string|null) – Reference to the document’s current status.
typeId (string|null) – Reference to the document’s type (if any).
deletedAt (string|null) – Timestamp if the document was deleted, otherwise null.
UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"workspaceId"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"documentId"}]}},"response":[{"id":"ce9c3ef1-774c-44b5-86ad-5c295faaedd8","name":"Move Document - OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Deletes a specific document within a given workspace. Once deleted, the document cannot be retrieved.
\nRoute Parameters
\nworkspace_id (string, required) – Unique identifier of the workspace the document belongs to.
document_id (string, required) – Unique identifier of the document to delete.
Request Body
\nStatus Codes
\n204 No Content – The document was successfully deleted. No response body is returned.
400 Bad Request – Invalid parameters were provided.
404 Not Found – The specified workspace or document could not be found.
Body
\nUUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"workspace_id"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"document_id"}]}},"response":[{"id":"5db9b89c-954c-4495-b14f-bffb6561ddcc","name":"Delete Document - OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"00000000-0000-0000-0000-000000000000","description":"UUID | Required | Document ID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.36.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Date","value":"Mon, 18 Aug 2025 20:48:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null},{"id":"c21fa544-b217-4d3d-b485-79319a25f2d5","name":"Delete Document - Validation failed (Route parameter)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"0000000-0000-0000-0000-0000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"0000000-0000-0000-0000-0000000000000","description":"UUID | Required | Document ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Validation failed (uuid is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"4516a5f7-ee0b-4630-9337-633edc0da3c2","name":"Delete Document - Workspace not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"0000000-0000-0000-0000-0000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"0000000-0000-0000-0000-0000000000000","description":"UUID | Required | Document ID"}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Workspace not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"},{"id":"39163cf7-24b3-4101-b345-1214edce46fc","name":"Delete Document - Document not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspace_id","documents",":document_id"],"variable":[{"key":"workspace_id","value":"0000000-0000-0000-0000-0000000000000","description":"UUID | Required | Workspace ID"},{"key":"document_id","value":"0000000-0000-0000-0000-0000000000000","description":"UUID | Required | Document ID"}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Document not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"}],"_postman_id":"d7b61292-0d98-4457-ba30-fd531f686cd9"},{"name":"Document Types","id":"0206dbe8-0f0e-464b-adb9-56be1f5f77f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/document-types","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"String | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"UUID | Default: Current Account | Account UUID target
\n","type":"text/plain"},"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c"},{"disabled":true,"description":{"content":"Boolean | Default: false | Filters by archived faxes if true
String | Search query string
\n","type":"text/plain"},"key":"query","value":"Admission"}],"variable":[]}},"response":[{"id":"2173d5f6-9ffa-4c71-9b2a-3f9acd3ead9c","name":"Document Types","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documo.com/ws/v2/document-types","host":["https://api.documo.com"],"path":["ws","v2","document-types"],"query":[{"key":"limit","value":"20","description":"String | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)","disabled":true},{"key":"offset","value":"0","description":"String | Default: 0 | Number of results to skip (used for pagination)","disabled":true},{"key":"accountId","value":"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c","description":"UUID | Default: Current Account | Account UUID target","disabled":true},{"key":"isArchived","value":"false","description":"Boolean | Default: false | Filters by archived faxes if `true`","disabled":true},{"key":"query","value":"Admission","description":"String | Query search text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"X-Next-Page-Available","value":"true","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2025-07-15T17:35:28.468Z\",\n \"updatedAt\": \"2025-10-31T18:29:38.829Z\",\n \"id\": \"e14131bd-54ec-42c4-85ed-7b74dd232d26\",\n \"name\": \"Admission Report\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"isLocked\": true,\n \"isArchived\": false,\n \"deletedAt\": null\n }\n]"}],"_postman_id":"0206dbe8-0f0e-464b-adb9-56be1f5f77f9"}],"id":"8d150308-d0be-4bed-bb96-ff0738aa8392","description":"This endpoint triggers the OCR processing for a specific document within a workspace.
\nNOTE: Requires OCR is turned on for the workspace.
\nMethod: PUT
\nPath Parameters:
\nworkspaceId (string, required): The ID of the workspace.
\nwsDocId (string, required): The ID of the document within the workspace.
\nUUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"workspace_id"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"document_id"}]}},"response":[],"_postman_id":"68264b46-3d02-4d42-81ca-ec8c62c48a5f"},{"name":"View OCR Data","id":"fbba8029-3065-49d7-bcb4-3f2b2d344070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ocr/v2/workspaces/:workspaceId/documents/:documentId","description":"This endpoint retrieves the details of a specific document within a workspace using the provided workspace ID and document ID.
\nworkspaceId (path parameter) : The ID of the workspace.
documentId (path parameter) : The ID of the document.
UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"workspaceId"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"0000000-0000-0000-0000-0000000000000","key":"documentId"}]}},"response":[],"_postman_id":"fbba8029-3065-49d7-bcb4-3f2b2d344070"},{"name":"Assign Document Type","id":"3d0fc6e1-04ac-422f-b7cb-dc5f28b06b08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"typeId","value":"88888888-8888-8888-8888-888888888888","type":"text","uuid":"fb6d6b4b-5c22-46bb-8d54-dcfd3859e5d4"}]},"url":"https://api.documo.com/ws/v2/workspaces/:workspace_id/documents/:document_id/document-types/assign","description":"This endpoint adds or edits the document type.
\ntypeId (string): The unique identifier of the type to assign to the document. Can be null to remove all type assignments.
Upon a successful update, the endpoint returns a status code of 200 and a JSON object with the updated details of the document, including:
\ncreatedAt (string): The timestamp of when the document was created or updated.
id (string): The unique identifier of the document.
workspaceId (string): The unique identifier of the workspace to which the document belongs.
name (string): The name of the document.
sourceType (string): The type of the document's source.
sourceId (string): The unique identifier of the document's source.
pagesCount (integer): The number of pages in the document.
type (object): The assigned document-type
id (string): The unique identifier of this document-type
name (string): The name of this document-type
locked (boolean): If true, document-type cannot be updated or deleted
UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"workspace_id"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"22222222-2222-2222-2222-222222222222","key":"document_id"}]}},"response":[{"id":"9b093b4d-1e79-4e3f-8648-6b4ee85dbc42","name":"Assign Document Type","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"22222222-2222-2222-2222-222222222222\",\n \"workspaceId\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"DK_upload1\",\n \"sourceType\": \"upload\", // \"upload\" | \"fax\" | \"email\"\n \"sourceId\": \"33333333-3333-3333-3333-333333333333\",\n \"from\": null,\n \"to\": null,\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"addedAt\": \"1970-01-01 00:00:00.000000\",\n \"pagesCount\": 1,\n \"typeId\": \"44444444-4444-4444-4444-444444444444\",\n \"statusId\": \"55555555-5555-5555-5555-555555555555\",\n \"isUploading\": false,\n \"type\": {\n \"createdAt\": \"1970-01-01 00:00:00.000000\",\n \"updatedAt\": \"1970-01-01 00:00:00.000000\",\n \"id\": \"88888888-8888-8888-8888-888888888888\",\n \"name\": \"Admission form\",\n \"accountId\": \"11111111-1111-1111-1111-111111111111\",\n \"locked\": false\n }\n }"}],"_postman_id":"3d0fc6e1-04ac-422f-b7cb-dc5f28b06b08"},{"name":"List Document Field Values","id":"15ac190d-0585-4dde-bd66-def1282339f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId/field-values","description":"This endpoint lists all the extracted data fields of the document.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This endpoint assigns document fields to that document.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","key":"workspaceId"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"2a251002-bf61-4e37-bd24-c7a13a1a9a00","key":"documentId"}]}},"response":[{"id":"375fe8da-d54a-400e-80c9-248935a82e46","name":"Assign Document Field Values","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fieldValues\": [\n {\n \"fieldId\": \"b85f5f5a-000f-4586-947c-a1ed197a4ca7\",\n \"value\": \"John\"\n },\n {\n \"fieldId\": \"27013664-6842-4905-abbe-bf4cbc8e1769\",\n \"value\": \"Doe\"\n },\n {\n \"fieldId\": \"555e410f-7404-4a34-8951-3db2c713264d\",\n \"value\": \"2000-04-04T12:00:00.297000Z\"\n },\n {\n \"fieldId\": \"fa9f7c47-da2e-4acc-8978-257e9ed28fe1\",\n \"value\": \"null\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId/field-values","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspaceId","documents",":documentId","field-values"],"variable":[{"key":"workspaceId","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f"},{"key":"documentId","value":"2a251002-bf61-4e37-bd24-c7a13a1a9a00"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Server-Version","value":"5.31.0"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"284"},{"key":"ETag","value":"W/\"11c-5cDkFlH8CUqewEGNZlOG1OWisPY\""},{"key":"Date","value":"Tue, 20 May 2025 14:00:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"fieldId\": \"b85f5f5a-000f-4586-947c-a1ed197a4ca7\",\n \"value\": \"John\"\n },\n {\n \"fieldId\": \"27013664-6842-4905-abbe-bf4cbc8e1769\",\n \"value\": \"Doe\"\n },\n {\n \"fieldId\": \"555e410f-7404-4a34-8951-3db2c713264d\",\n \"value\": \"2000-04-04T12:00:00.297Z\"\n },\n {\n \"fieldId\": \"fa9f7c47-da2e-4acc-8978-257e9ed28fe1\",\n \"value\": \"null\"\n }\n]"}],"_postman_id":"be6f4e51-88d0-4706-b09f-c660528e382b"},{"name":"Request Document Classification","id":"6babd63d-ec9f-4e4d-b891-0e4f899a21d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId/classification/request","description":"Use this endpoint to initiate document classification before viewing the document type.
\n","urlObject":{"path":["ws","v2","workspaces",":workspaceId","documents",":documentId","classification","request"],"host":["https://api.documo.com"],"query":[],"variable":[{"description":{"content":"UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","key":"workspaceId"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"2a251002-bf61-4e37-bd24-c7a13a1a9a00","key":"documentId"}]}},"response":[{"id":"f6327a7d-0d36-4c35-a15d-c9cb457925d9","name":"Request Classification for workspace document","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:wsDocId/classification/request","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspaceId","documents",":wsDocId","classification","request"],"variable":[{"key":"workspaceId","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","description":"Workspace ID | UUID"},{"key":"wsDocId","value":"68539c8b-79d3-4fdb-a061-8fc0218c25c2","description":"Workspace Document ID | UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 06 Mar 2026 12:00:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6babd63d-ec9f-4e4d-b891-0e4f899a21d9"},{"name":"Request Document Extraction","id":"8189aa12-3d2a-49c3-a9e8-56535131d561","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId/extraction/request","description":"Use this endpoint to initiate document extraction before viewing the extracted fields.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","key":"workspaceId"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"2a251002-bf61-4e37-bd24-c7a13a1a9a00","key":"documentId"}]}},"response":[{"id":"94b08f65-7715-4b33-8252-8a6cad717299","name":"Request Extraction for workspace document","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:wsDocId/extraction/request","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspaceId","documents",":wsDocId","extraction","request"],"variable":[{"key":"workspaceId","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","description":"Workspace ID | UUID"},{"key":"wsDocId","value":"68539c8b-79d3-4fdb-a061-8fc0218c25c2","description":"Workspace Document ID | UUID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Date","value":"Thu, 06 Mar 2026 12:00:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8189aa12-3d2a-49c3-a9e8-56535131d561"},{"name":"Request Document Split Detection","id":"bebce085-69ad-4afb-bd81-d04950b3c724","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId/split-detection/request","description":"Use this endpoint to initiate split detection before viewing auto-split suggestions.
\n","urlObject":{"path":["ws","v2","workspaces",":workspaceId","documents",":documentId","split-detection","request"],"host":["https://api.documo.com"],"query":[],"variable":[{"description":{"content":"UUID | Required | Workspace ID
\n","type":"text/plain"},"type":"any","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","key":"workspaceId"},{"description":{"content":"UUID | Required | Document ID
\n","type":"text/plain"},"type":"any","value":"2a251002-bf61-4e37-bd24-c7a13a1a9a00","key":"documentId"}]}},"response":[{"id":"939560ea-240b-4b6f-bd4f-53c357a2a56b","name":"Request Split Detection for workspace document","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic {{API_KEY}}"}],"url":{"raw":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:wsDocId/split-detection/request","host":["https://api.documo.com"],"path":["ws","v2","workspaces",":workspaceId","documents",":wsDocId","split-detection","request"],"variable":[{"key":"workspaceId","value":"15849a41-f5a8-493a-83e2-b6cb2ac3bb9f","description":"Workspace ID | UUID"},{"key":"wsDocId","value":"68539c8b-79d3-4fdb-a061-8fc0218c25c2","description":"Workspace Document ID | UUID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"X-Next-Page-Available, X-Total-Count, Content-Disposition"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"180"},{"key":"X-RateLimit-Remaining","value":"179"},{"key":"X-RateLimit-Reset","value":"60"},{"key":"Date","value":"Thu, 06 Mar 2026 12:00:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bebce085-69ad-4afb-bd81-d04950b3c724"},{"name":"View Document Split Detection Data","id":"7363cc70-c1a3-4f44-ad67-a715bd8ae2a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/workspaces/:workspaceId/documents/:documentId/split-detection/latest","description":"Retrieve the latest split detection analysis results for a workspace document. Returns the detected segments (page groupings) with confidence scores.
\nReturns null if no successful split detection analysis has been performed on the document.
Requires the account to have IDP feature enabled.
\nAPI Key Access: base | admin
UUID | Required | The workspace containing the document
\n","type":"text/plain"},"type":"any","value":"d1077489-5ea1-4db1-9760-853f175e8288","key":"workspaceId"},{"description":{"content":"UUID | Required | The document to retrieve split detection data for
\n","type":"text/plain"},"type":"any","value":"d1077489-5ea1-4db1-9760-853f175e8288","key":"documentId"}]}},"response":[{"id":"7cf2533b-06f7-4263-9b2a-c5b8f222dff6","name":"200 — Success","originalRequest":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/workspaces/d1077489-5ea1-4db1-9760-853f175e8288/documents/e0e72262-bf92-47ed-a78c-69547479cad8/split-detection/latest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"analysisId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"modelVersion\": \"1.0.0\",\n \"executionTime\": 2340,\n \"warnings\": null,\n \"segments\": [\n {\n \"pages\": [1, 2, 3],\n \"confidence\": 0.95\n },\n {\n \"pages\": [4, 5],\n \"confidence\": 0.88\n },\n {\n \"pages\": [6, 7, 8, 9],\n \"confidence\": 0.92\n }\n ]\n}"},{"id":"c5b54271-903a-4611-8617-e1c7f3771bad","name":"200 — No Analysis Data","originalRequest":{"method":"GET","header":[],"url":"https://api.documo.com/ws/v2/workspaces/d1077489-5ea1-4db1-9760-853f175e8288/documents/cc38a979-fedb-4f27-9ad1-4ba1375ec9f8/split-detection/latest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"}],"_postman_id":"7363cc70-c1a3-4f44-ad67-a715bd8ae2a2"}],"id":"745697af-ad01-439d-a2a0-0be61b3b2ad3","_postman_id":"745697af-ad01-439d-a2a0-0be61b3b2ad3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Testing folder description
\n()
\n","_postman_id":"208ccfc7-61a5-4ad2-83cd-f230b0799ce5","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"