{"info":{"_postman_id":"a1de7055-91ae-453f-a01c-bb73e13f7612","name":"api.securedocex.com Samples","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"API INTEGRATION","item":[{"name":"Generate OAuth2 token","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"bearer-token\", jsonData.access_token);"]}}],"_postman_id":"c34f54f5-351c-446e-a156-a0a856d58447","request":{"auth":{"type":"basic","basic":{"username":"{{app_id}}","password":"{{api_key}}","showPassword":false}},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"Sets the OAuth2 grant type flow","type":"text"}]},"url":"https://api.securedocex.com/tokens"},"response":[]}],"_postman_id":"642e9c53-d52f-4512-a5ea-40630967eb51","event":[{"listen":"prerequest","script":{"id":"a0ef6115-1895-4dfe-be9e-f63858d9bd7e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4fb25338-94c4-49b3-a874-0558fa0cbf63","type":"text/javascript","exec":[""]}}],"protocolProfileBehavior":{}},{"name":"FAXES - MULTIPLE","item":[{"name":"Query received faxes","_postman_id":"0ee1e34f-26df-4289-aa57-533d8850db81","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"pagination-offset","value":"","description":"Starting record for page of results","disabled":true},{"key":"pagination-limit","value":"","description":"Number of records to include in a page","disabled":true},{"key":"transaction-id","value":"","description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}],"url":{"raw":"https://api.securedocex.com/faxes/received","protocol":"https","host":["api","securedocex","com"],"path":["faxes","received"],"query":[{"key":"originating_fax_number","value":null,"description":"The number the fax was transmitted from","disabled":true},{"key":"destination_fax_number","value":null,"description":"The number the fax was transmitted to","disabled":true},{"key":"min_pages","value":null,"description":"Minimum page count of the fax","disabled":true},{"key":"max_pages","value":null,"description":"Maximum page count of the fax","disabled":true},{"key":"min_completed_timestamp","value":null,"description":"Start time to filter on (earlier)","disabled":true},{"key":"max_completed_timestamp","value":null,"description":"End time to filter on (later)","disabled":true},{"key":"image_downloaded","value":null,"description":"If TRUE list downloaded images","disabled":true},{"key":"search_text","value":null,"description":"Search metadata text fields for supplied text","disabled":true}]}},"response":[]},{"name":"Query sent faxes","_postman_id":"9b80d5b9-a323-4b85-ab07-6bffa8b0350e","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"pagination-offset","value":"","description":"Starting record for page of results","disabled":true},{"key":"pagination-limit","value":"","description":"Number of records to include in a page","disabled":true},{"key":"transaction-id","value":"","description":"User generated id for tracking requests","disabled":true}],"url":{"raw":"https://api.securedocex.com/faxes/sent","protocol":"https","host":["api","securedocex","com"],"path":["faxes","sent"],"query":[{"key":"transmission status","value":"COMPLETE","description":"Allowed: NEW, INPROGRESS, COMPLETE, ERROR","disabled":true},{"key":"error_code","value":null,"description":"Fax transmission error code","disabled":true},{"key":"originating_fax_number","value":null,"description":"The number the fax was transmitted from","disabled":true},{"key":"destination_fax_number","value":null,"description":"The number the fax was transmitted to","disabled":true},{"key":"min_pages","value":null,"description":"Minimum page count of the fax","disabled":true},{"key":"max_pages","value":null,"description":"Maximum page count of the fax","disabled":true},{"key":"min_completed_timestamp","value":null,"description":"Start time to filter on (earlier)","disabled":true},{"key":"max_completed_timestamp","value":null,"description":"End time to filter on (later)","disabled":true},{"key":"image_downloaded","value":null,"description":"If TRUE list downloaded images","disabled":true},{"key":"fax_status","value":null,"description":"Allowed: NEW, QUEUED, SENT, STORED","disabled":true},{"key":"search_text","value":null,"description":"Search metadata text fields for supplied text","disabled":true},{"key":"transaction-id","value":null,"description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}]}},"response":[]},{"name":"Multiple Faxes Metadata","_postman_id":"3c53849d-dbeb-4162-ad4c-3d08e1cc47fa","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}"},{"description":"Starting record for page of results","key":"pagination-offset","value":"","disabled":true},{"description":"Number of records to include in a page","key":"pagination-limit","value":"","disabled":true},{"description":"User generated id for tracking requests","key":"transaction-id","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n  \"fax_ids\": [\n    \"a81ad7c3-7be6-d9fe-e053-680c940aa098\",\n    \"a13ba190-7db8-0816-e053-690c940a6db7\"\n  ]\n}"},"url":{"raw":"https://api.securedocex.com/faxes/metadata","protocol":"https","host":["api","securedocex","com"],"path":["faxes","metadata"],"query":[{"key":"transmission status","value":"COMPLETE","description":"Allowed: NEW, INPROGRESS, COMPLETE, ERROR","disabled":true},{"key":"error_code","value":null,"description":"Fax transmission error code","disabled":true},{"key":"originating_fax_number","value":null,"description":"The number the fax was transmitted from","disabled":true},{"key":"destination_fax_number","value":null,"description":"The number the fax was transmitted to","disabled":true},{"key":"min_pages","value":null,"description":"Minimum page count of the fax","disabled":true},{"key":"max_pages","value":null,"description":"Maximum page count of the fax","disabled":true},{"key":"min_completed_timestamp","value":null,"description":"Start time to filter on (earlier)","disabled":true},{"key":"max_completed_timestamp","value":null,"description":"End time to filter on (later)","disabled":true},{"key":"image_downloaded","value":null,"description":"If TRUE list downloaded images","disabled":true},{"key":"fax_status","value":null,"description":"Allowed: NEW, QUEUED, SENT, STORED","disabled":true},{"key":"search_text","value":null,"description":"Search metadata text fields for supplied text","disabled":true},{"key":"transaction-id","value":null,"description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}]}},"response":[]}],"_postman_id":"b5478a1a-9d15-4145-beee-c41ade78edd8","protocolProfileBehavior":{}},{"name":"FAXES - INDIVIDUAL","item":[{"name":"Send a fax","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"fax-id\", jsonData[0].fax_id);"]}}],"_postman_id":"1207c959-b880-45b2-b9ed-ce88a02afc68","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"Content-Type","value":"application/json"},{"key":"transaction-id","value":"","description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}],"body":{"mode":"raw","raw":"{\n    \"client_data\": {\n        \"billing_code\": \"This is a test\",\n        \"client_code\": \"client code\",\n        \"client_id\": \"client id\",\n        \"client_matter\": \"client matter\",\n        \"client_name\": \"client name\",\n        \"client_reference_id\": \"Client refernce id\"\n    },\n    \"destinations\": [\n        {\n            \"fax_number\" : \"13232972460\",\n            \"to_name\" : \"Bob Smith\",\n            \"to_company\": \"Acme Widgets Inc.\"\n        }\n    ],\n    \"documents\": [\n        {\n            \"document_content\": \"SW50ZWdyYXRpb24gdGVzdCBvcHRpY2FsIGJ5cGFzc2luZyBTbWFsbA==\",\n            \"document_type\": \"PDF\"\n        }\n    ],\n   \"fax_options\" : {\n        \"image_resolution\" : \"FINE\",\n        \"include_cover_page\" : \"true\",\n        \"custom_CallerID\" : \"18189785900\",\n        \"header_options\": {\n        \"line_1\":[\"${CSID}\", \"${DATE_TIME2}\", \"${FAX_ID}\", \"Page: ${CURRENT_PAGE} / ${TOTAL_PAGE}\"]\n    },\n        \"custom_CSID\" : \"custom csid\",\n        \"cover_page_options\" : {\n            \"from_name\" : \"Mary Adams\",\n            \"subject\" : \"Information Fax\",\n            \"message\" : \"Sample fax\",\n    \"retry_options\":{\n         \"non_billable\":4,\n         \"billable\":10,\n         \"human_answer\":1\n     }\n   }\n  }\n}"},"url":"https://api.securedocex.com/faxes"},"response":[]},{"name":"Get fax metadata","_postman_id":"4347474b-84c1-435a-814f-dd476221e60c","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"transaction-id","value":"","description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}],"url":"https://api.securedocex.com/faxes/{{fax-id}}/metadata"},"response":[]},{"name":"Patch fax metadata","_postman_id":"a4204a63-1a3c-46b6-875f-542cc53560fd","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"PATCH","header":[{"key":"user-id","value":"{{user-id}}"},{"description":"Optional user generated unique id  (UUID) for tracking requests","key":"transaction-id","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n  \"image_downloaded\": true\n}"},"url":"https://api.securedocex.com/faxes/{{fax-id}}/metadata"},"response":[]},{"name":"Get fax image","_postman_id":"253b3395-6ed9-4cba-a08c-9c18129be61c","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"transaction-id","value":"","description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}],"url":"https://api.securedocex.com/faxes/{{fax-id}}/image"},"response":[]},{"name":"Delete a fax","_postman_id":"f1fc1bc1-bce6-48c1-a7e8-5f525ea445c6","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"DELETE","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"transaction-id","value":"","description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}],"url":"https://api.securedocex.com/faxes/{{fax-id}}"},"response":[]}],"_postman_id":"a2c42653-5fab-4df1-a023-f715a067c713","protocolProfileBehavior":{}},{"name":"GENERAL","item":[{"name":"Health Check","_postman_id":"0ba29ca9-eb36-4acf-b185-c26fd4faa965","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","value":"{{user-id}}"},{"key":"pagination-offset","value":"","description":"Starting record for page of results","disabled":true},{"key":"pagination-limit","value":"","description":"Number of records to include in a page","disabled":true},{"key":"transaction-id","value":"","description":"Optional user generated unique id  (UUID) for tracking requests","disabled":true}],"url":{"raw":"https://api.securedocex.com/health","protocol":"https","host":["api","securedocex","com"],"path":["health"],"query":[{"key":"originating_fax_number","value":null,"description":"The number the fax was transmitted from","disabled":true},{"key":"destination_fax_number","value":null,"description":"The number the fax was transmitted to","disabled":true},{"key":"min_pages","value":null,"description":"Minimum page count of the fax","disabled":true},{"key":"max_pages","value":null,"description":"Maximum page count of the fax","disabled":true},{"key":"min_completed_timestamp","value":null,"description":"Start time to filter on (earlier)","disabled":true},{"key":"max_completed_timestamp","value":null,"description":"End time to filter on (later)","disabled":true},{"key":"image_downloaded","value":null,"description":"If TRUE list downloaded images","disabled":true},{"key":"search_text","value":null,"description":"Search metadata text fields for supplied text","disabled":true}]}},"response":[]}],"_postman_id":"f4e35d74-bc31-4921-9634-813c08939aab","protocolProfileBehavior":{}},{"name":"NOTIFICATIONS","item":[{"name":"GET /notifications Inbound","_postman_id":"4124f3b0-cad8-4946-b08f-4feade7a473b","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","type":"text","value":"{{user-id}}"}],"url":{"raw":"https://api.securedocex.com/notifications?fax_direction=Inbound","protocol":"https","host":["api","securedocex","com"],"path":["notifications"],"query":[{"key":"fax_direction","value":"Inbound"}]}},"response":[]},{"name":"GET /notifications Outbound","_postman_id":"221d2594-1eba-4955-919a-ad27586f100c","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","type":"text","value":"{{user-id}}"}],"url":{"raw":"https://api.securedocex.com/notifications?fax_direction=OUTBOUND","protocol":"https","host":["api","securedocex","com"],"path":["notifications"],"query":[{"key":"fax_direction","value":"OUTBOUND"}]}},"response":[]}],"_postman_id":"e438266f-aa65-4242-8391-a334b96ed581","protocolProfileBehavior":{}},{"name":"FAX CANCEL","item":[{"name":"POST /faxes Cancel","_postman_id":"472fbec7-d564-4e43-a28f-2470c90445b8","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"POST","header":[{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"transaction-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":"https://api.securedocex.com/faxes/{{fax-id}}/cancel"},"response":[]}],"_postman_id":"a9728c8b-8807-44ae-8aa4-16787d555ee7","protocolProfileBehavior":{}},{"name":"DOWNLOAD SPECIFIC PAGES","item":[{"name":"GET /faxes/{fax_id}/image/pages - Download specific pages","_postman_id":"41ac3745-a116-4592-af00-ad3a3f0b1dac","request":{"auth":{"type":"bearer","bearer":{"token":"{{bearer-token}}"}},"method":"GET","header":[{"key":"user-id","type":"text","value":"{{user-id}}"}],"url":{"raw":"https://api.securedocex.com/faxes/{{fax-id}}/image/pages?start_page=1&num_pages=5","protocol":"https","host":["api","securedocex","com"],"path":["faxes","{{fax-id}}","image","pages"],"query":[{"key":"start_page","value":"1"},{"key":"num_pages","value":"5"}]}},"response":[]}],"_postman_id":"80a588b1-2d69-4e86-bcc3-17b6011cb0c5","protocolProfileBehavior":{}}],"event":[{"listen":"prerequest","script":{"id":"b4248e13-6a0d-4b2e-9469-ae4f5982adb0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c07b3b7-7fb0-4d73-8d87-13295b7cadc5","type":"text/javascript","exec":[""]}}],"variable":[{"id":"ec2e7c00-cf16-487e-9439-35660258a0c2","key":"app-id","value":"","type":"string"},{"id":"2f42232f-55f2-4dbf-91aa-7d7b74f2724b","key":"api-key","value":"","type":"string"},{"id":"877e322e-39c5-4aad-a829-646d384f3941","key":"user-id","value":"","type":"string"},{"id":"07203846-b332-4265-9981-b5b52b492a70","key":"bearer-token","value":"","type":"string"},{"id":"6f9c7339-f0da-42d2-a64f-41c10c6b57c6","key":"fax-id","value":"","type":"string"}],"protocolProfileBehavior":{}}