{"info":{"_postman_id":"d84b2e8b-d7c3-4613-90b7-d159b94f044a","name":"SecureFax v3 API","description":"

SecureFax uses a specialized Auth system based on Auth0. For developing purposes you can get your access token from Local Storage after logging into SecureFax at https://app.mysecurefax.com

1. Log into https://app.mysecurefax.com

2. Open dev tools by pressing F12

3. Navigate to Application

4. Navigate to Local Storage and copy out the accessToken

5. Paste the accessToken in the bearerToken variable in Postman.

\n $\"\"$ \n\n

If you need to integrate your application into SecureFax contact our Engineering department at https://support.onecloud.com.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7747764","collectionId":"d84b2e8b-d7c3-4613-90b7-d159b94f044a","publishedId":"2sA2rGvf6c","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"38a6de"},"publishDate":"2024-03-01T01:05:39.000Z"},"item":[{"name":"fax","item":[{"name":"Send Fax","id":"b8e79401-3b7e-4fe9-9a1a-32230755fa71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","type":"text","description":"

(Required) Must match email/username in token

\n"},{"key":"from_number","value":"","type":"text","description":"

(Required) Must be a number in users account

\n"},{"key":"to_number","value":"","type":"text","description":"

(Required) 10 Digit number to send fax to

\n"},{"key":"fax_file","type":"file","description":"

(Required) Fax file to send

\n","value":null},{"key":"notes","value":"","type":"text","description":"

Notes to be included when saving fax

\n"},{"key":"cover_subject","value":"","type":"text","description":"

Cover Page subject, only used if not uploading a cover page

\n"},{"key":"cover_body","value":"","type":"text","description":"

Cover Page body, only used if not uploading a cover page

\n"},{"key":"cover_to_name","value":"","type":"text","description":"

Cover Page to name, only used if not uploading a cover page

\n"},{"key":"cover_from_name","value":"","type":"text","description":"

Cover Page from name, only used if not uploading a cover page

\n"},{"key":"cover_page","type":"file","description":"

A custom cover page

\n","value":null},{"key":"auto_generate_cover_page","value":"","type":"text","description":"

If set to yes, will auto generate a cover page with the form data

\n"}]},"url":"https://api.mysecurefax.com/api/v2/fax/send_fax","description":"

This HTTP POST request is used to send a fax via the API. The request should be made to https://api.mysecurefax.com/api/v2/fax/send_fax with a form-data request body type. The request payload should include the necessary data to send the fax. Upon a successful request, the API will respond with a JSON object containing the status, message, and uuid of the sent fax.

Example Response:

{\n    \"status\": \"\",\n    \"message\": \"\",\n    \"uuid\": \"\"\n}\n

\n","urlObject":{"path":["api","v2","fax","send_fax"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[]}},"response":[{"id":"563d601e-d622-4b87-93a2-8a1201b9bff7","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Must match email/username in token","key":"username","value":"","type":"text"},{"description":"(Required) Must be a number in users account","key":"from_number","value":"","type":"text"},{"description":"(Required) 10 Digit number to send fax to","key":"to_number","value":"","type":"text"},{"description":"(Required) ","key":"fax_file","value":"[\"\",\"\"]","type":"text"},{"description":"Notes to be included when saving fax","key":"notes","value":"","type":"text"},{"description":"Cover Page subject, only used if not uploading a cover page","key":"cover_subject","value":"","type":"text"},{"description":"Cover Page body, only used if not uploading a cover page","key":"cover_body","value":"","type":"text"},{"description":"Cover Page to name, only used if not uploading a cover page","key":"cover_to_name","value":"","type":"text"},{"description":"Cover Page from name, only used if not uploading a cover page","key":"cover_from_name","value":"","type":"text"},{"key":"cover_page","value":"[\"\",\"\"]","type":"text"},{"description":"If set to yes, will auto generate a cover page with the form data","key":"auto_generate_cover_page","value":"","type":"text"}]},"url":"https://api.mysecurefax.com/api/v2/fax/send_fax"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"Accepted\",\r\n \"message\": \"Fax Queued\",\r\n \"uuid\": \"759b5536-64f5-4dg6-8be7-83be65d171ba\"\r\n}"},{"id":"8652fb3c-daf2-4427-a678-de51a69b695e","name":"Validation Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Must match email/username in token","key":"username","value":"","type":"text"},{"description":"(Required) Must be a number in users account","key":"from_number","value":"","type":"text"},{"description":"(Required) 10 Digit number to send fax to","key":"to_number","value":"","type":"text"},{"description":"(Required) ","key":"fax_file","value":"[\"\",\"\"]","type":"text"},{"description":"Notes to be included when saving fax","key":"notes","value":"","type":"text"},{"description":"Cover Page subject, only used if not uploading a cover page","key":"cover_subject","value":"","type":"text"},{"description":"Cover Page body, only used if not uploading a cover page","key":"cover_body","value":"","type":"text"},{"description":"Cover Page to name, only used if not uploading a cover page","key":"cover_to_name","value":"","type":"text"},{"description":"Cover Page from name, only used if not uploading a cover page","key":"cover_from_name","value":"","type":"text"},{"key":"cover_page","value":"[\"\",\"\"]","type":"text"},{"description":"If set to yes, will auto generate a cover page with the form data","key":"auto_generate_cover_page","value":"","type":"text"}]},"url":"https://api.mysecurefax.com/api/v2/fax/send_fax"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"b8e79401-3b7e-4fe9-9a1a-32230755fa71"},{"name":"Fax Download ","id":"3d517773-55a5-4777-900e-876a250c892f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/download/:id/:uuid","description":"

This endpoint allows you to download a fax by providing the fax ID and UUID in the URL parameters.

The response will contain the downloaded fax file.

\n","urlObject":{"path":["api","v2","fax","download",":id",":uuid"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"description":{"content":"

(Required) The ID of your user

\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"

(Required) The Unique ID of the fax you want to download

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"4149167b-e564-459b-99f7-bb7985980488","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/download/:id/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","download",":id",":uuid"],"variable":[{"key":"id","value":"","description":"(Required) "},{"key":"uuid","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/pdf"},{"key":"Content-Disposition","value":"attachment; filename=to-55555558680-from-55555553815-02-29-2024-07-29PM-[note].pdf","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"21620785-8cc1-4bfa-8d9b-acc4a17ac966","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/download/:id/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","download",":id",":uuid"],"variable":[{"key":"id","value":"","description":"(Required) "},{"key":"uuid","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"3d517773-55a5-4777-900e-876a250c892f"},{"name":"Get Faxes","id":"baaf60c1-02c8-4183-a226-e44e80f37a0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_faxes?username=&page=1&per_page=10&phone_number=&order_by=asc&search_query=&hide_deleted=yes&direction=both&status_filter=all&start_date=&end_date=","description":"

This endpoint makes an HTTP GET request to retrieve a list of faxes. The request includes query parameters such as username, page, per_page, phone_number, order_by, search_query, hide_deleted, direction, status_filter, start_date, and end_date. The username, page, per_page, phone_number, start_date, and end_date are required parameters, while the rest are optional.

The response will contain the requested list of faxes, with details such as fax ID, sender information, recipient information, status, date, and more.

Example Response:

{\n  \"faxes\": [\n    {\n      \"from_number\": \"9805555555\",\n      \"to_number\": \"9805556666\",\n      \"direction\": \"Out\",\n      \"pages\": 2,\n      \"created_on\": \"08-25-2023 03:04 PM\",\n      \"viewed\": \"yes\",\n      \"uuid\": \"c3433743d-3f2a-41a1-b71c-940dd6806ac1\",\n      \"notes\": \"Testing Storage\",\n      \"download_link\": \"https://api.mysecurefax.net/api/v2/fax/download/100964/c3433743d-3f2a-41a1-b71c-940dd6806ac1\",\n      \"friendly_name\": \"friendly_filename.pdf\",\n      \"fax_log\": [\n        \"[2023-08-25 19:07:04 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\"\n      ]\n    },\n    {\n      \"from_number\": \"9805555555\",\n      \"to_number\": \"3026668989\",\n      \"direction\": \"Out\",\n      \"pages\": 2,\n      \"created_on\": \"08-25-2023 01:53 PM\",\n      \"viewed\": \"yes\",\n      \"uuid\": \"510b7693-44b9-8829-8034-0855742761e4\",\n      \"notes\": \"Testing Storage\",\n      \"download_link\": \"https://api.mysecurefax.net/api/v2/fax/download/100964/510b7693-44b9-8829-8034-0855742761e4\",\n      \"friendly_name\": \"friendly_filename.pdf\",\n      \"fax_log\": [\n        \"[2023-08-25 18:20:23 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\n        \"[2023-08-28 13:25:57 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\n        \"[2023-08-28 13:27:54 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\n        \"[2023-08-28 13:33:39 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\n        \"[2023-08-28 13:35:00 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\"\n      ]\n    },\n    {\n      \"from_number\": \"9805555555\",\n      \"to_number\": \"3026668989\",\n      \"direction\": \"Out\",\n      \"pages\": 2,\n      \"created_on\": \"08-25-2023 12:04 PM\",\n      \"viewed\": \"yes\",\n      \"uuid\": \"acfdfda8-05f9-899a-adca-2e919e096091\",\n      \"notes\": \"Testing Storage\",\n      \"download_link\": \"https://api.mysecurefax.net/api/v2/fax/download/100964/acfdfda8-05f9-899a-adca-2e919e096091\",\n      \"friendly_name\": \"friendly_filename.pdf\",\n      \"fax_log\": [\n        \"[2023-08-25 16:07:28 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\n        \"[2023-08-25 16:12:13 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\n        \"[2023-08-25 16:14:24 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\"\n      ]\n    }\n  ],\n  \"total_pages\": 1,\n  \"current_page\": 1,\n  \"per_page\": 10,\n  \"total_faxes\": 3\n}\n\n

\n","urlObject":{"path":["api","v2","fax","get_faxes"],"host":["https://api.mysecurefax.com"],"query":[{"description":{"content":"

(Required) Username requesting the faxes. Example: john@example.com

\n","type":"text/plain"},"key":"username","value":""},{"description":{"content":"

Page number you want from the results

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of results per page

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

(Required) The ten digit phone number. Example: '9805558989'

\n","type":"text/plain"},"key":"phone_number","value":""},{"description":{"content":"

asc|desc

\n","type":"text/plain"},"key":"order_by","value":"asc"},{"description":{"content":"

Search filter

\n","type":"text/plain"},"key":"search_query","value":""},{"description":{"content":"

yes|no to hide deleted records

\n","type":"text/plain"},"key":"hide_deleted","value":"yes"},{"description":{"content":"

in|out|both

\n","type":"text/plain"},"key":"direction","value":"both"},{"description":{"content":"

delivered|sending|failed|all

\n","type":"text/plain"},"key":"status_filter","value":"all"},{"description":{"content":"

Example: '2023-08-31'

\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"

Example: '2023-08-31'

\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[{"id":"e88f6238-d8c9-485a-ae46-e79475c8177e","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_faxes?username=&page=1&per_page=10&phone_number=&order_by=asc&search_query=&hide_deleted=yes&direction=both&status_filter=all&start_date=&end_date=","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_faxes"],"query":[{"key":"username","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"phone_number","value":""},{"key":"order_by","value":"asc"},{"key":"search_query","value":""},{"key":"hide_deleted","value":"yes"},{"key":"direction","value":"both"},{"key":"status_filter","value":"all"},{"key":"start_date","value":""},{"key":"end_date","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"faxes\": [\r\n {\r\n \"from_number\": \"9805555555\",\r\n \"to_number\": \"9805556666\",\r\n \"direction\": \"Out\",\r\n \"pages\": 2,\r\n \"created_on\": \"08-25-2023 03:04 PM\",\r\n \"viewed\": \"yes\",\r\n \"uuid\": \"c3433743d-3f2a-41a1-b71c-940dd6806ac1\",\r\n \"notes\": \"Testing Storage\",\r\n \"download_link\": \"https://api.mysecurefax.net/api/v2/fax/download/100964/c3433743d-3f2a-41a1-b71c-940dd6806ac1\",\r\n \"friendly_name\": \"friendly_filename.pdf\",\r\n \"fax_log\": [\r\n \"[2023-08-25 19:07:04 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\"\r\n ]\r\n },\r\n {\r\n \"from_number\": \"9805555555\",\r\n \"to_number\": \"3026668989\",\r\n \"direction\": \"Out\",\r\n \"pages\": 2,\r\n \"created_on\": \"08-25-2023 01:53 PM\",\r\n \"viewed\": \"yes\",\r\n \"uuid\": \"510b7693-44b9-8829-8034-0855742761e4\",\r\n \"notes\": \"Testing Storage\",\r\n \"download_link\": \"https://api.mysecurefax.net/api/v2/fax/download/100964/510b7693-44b9-8829-8034-0855742761e4\",\r\n \"friendly_name\": \"friendly_filename.pdf\",\r\n \"fax_log\": [\r\n \"[2023-08-25 18:20:23 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\r\n \"[2023-08-28 13:25:57 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\r\n \"[2023-08-28 13:27:54 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\r\n \"[2023-08-28 13:33:39 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\r\n \"[2023-08-28 13:35:00 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\"\r\n ]\r\n },\r\n {\r\n \"from_number\": \"9805555555\",\r\n \"to_number\": \"3026668989\",\r\n \"direction\": \"Out\",\r\n \"pages\": 2,\r\n \"created_on\": \"08-25-2023 12:04 PM\",\r\n \"viewed\": \"yes\",\r\n \"uuid\": \"acfdfda8-05f9-899a-adca-2e919e096091\",\r\n \"notes\": \"Testing Storage\",\r\n \"download_link\": \"https://api.mysecurefax.net/api/v2/fax/download/100964/acfdfda8-05f9-899a-adca-2e919e096091\",\r\n \"friendly_name\": \"friendly_filename.pdf\",\r\n \"fax_log\": [\r\n \"[2023-08-25 16:07:28 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\r\n \"[2023-08-25 16:12:13 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\",\r\n \"[2023-08-25 16:14:24 UTC][fake.email@gmail.com][1.1.1.1][fax viewed]\"\r\n ]\r\n }\r\n ],\r\n \"total_pages\": 1,\r\n \"current_page\": 1,\r\n \"per_page\": 10,\r\n \"total_faxes\": 3\r\n}"},{"id":"c62ecdae-b9cc-4a72-9b96-b5c33c69c6a9","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_faxes?username=&page=1&per_page=10&phone_number=&order_by=asc&search_query=&hide_deleted=yes&direction=both&status_filter=all&start_date=&end_date=","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_faxes"],"query":[{"key":"username","value":""},{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"phone_number","value":""},{"key":"order_by","value":"asc"},{"key":"search_query","value":""},{"key":"hide_deleted","value":"yes"},{"key":"direction","value":"both"},{"key":"status_filter","value":"all"},{"key":"start_date","value":""},{"key":"end_date","value":""}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"baaf60c1-02c8-4183-a226-e44e80f37a0a"},{"name":"Delete Fax","id":"5d916a4c-8ccc-414d-9d98-f8c7e01ff050","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.mysecurefax.com/api/v2/fax/delete","urlObject":{"path":["api","v2","fax","delete"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[]}},"response":[{"id":"e411e3cc-4ce3-4d78-a4ee-ef5b5770b9ce","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.mysecurefax.com/api/v2/fax/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"f43bdbac-a457-47d9-930a-a1cb5dc8bf79","name":"Validation Error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"language":"json"}}},"url":"https://api.mysecurefax.com/api/v2/fax/delete"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"5d916a4c-8ccc-414d-9d98-f8c7e01ff050"},{"name":"Fax Update ","id":"272e498f-f998-4d6c-90ab-ead054295571","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"notes\": \"\",\n \"read\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mysecurefax.com/api/v2/fax/update/:uuid","description":"

This HTTP POST request is used to update a specific fax by providing its UUID in the endpoint URL. The request should include a JSON payload in the raw request body type, with optional parameters \"notes\" and \"read\".

Request Body

notes (optional, string): Additional notes for the fax.
read (optional, boolean): Indicates whether the fax has been read.

Response

The response will include the updated information of the fax, with the specific details based on the provided UUID.

Example response:

{\n}\n\n

\n","urlObject":{"path":["api","v2","fax","update",":uuid"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"description":{"content":"

(Required) Fax Unique ID

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"a177768b-5573-4523-9a6f-c3204e179877","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"notes\": \"\",\n \"read\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/update/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","update",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n}"},{"id":"05602b57-577e-46b4-9476-25e7979f33d2","name":"Validation Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"notes\": \"\",\n \"read\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/update/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","update",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"272e498f-f998-4d6c-90ab-ead054295571"},{"name":"Get Status ","id":"876922e0-ee84-4842-a5e0-979866a29268","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_status/:uuid","urlObject":{"path":["api","v2","fax","get_status",":uuid"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"description":{"content":"

(Required) Unique ID of the Fax

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"9df3540b-8b4e-413f-b272-b74dc7c9e9f6","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_status/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_status",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"uuid\": \"\",\r\n \"status\": \"delivered\",\r\n \"pages_sent\": 1\r\n}"},{"id":"6284b173-d39b-4331-a71a-317df505bcb0","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_status/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_status",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"876922e0-ee84-4842-a5e0-979866a29268"},{"name":"Get Number ","id":"c1cc3a78-44fc-403b-a398-e7de437498d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_number/:number","description":"

This HTTP GET request retrieves information about a specific fax number from the API. The request should be made to the endpoint https://api.mysecurefax.com/api/v2/fax/get_number/:number, where :number should be replaced with the actual fax number.

The response will include the following fields:

did: The fax number.
total_pages: The total number of pages associated with the fax number.
license: The license information for the fax number.
license_description: Description of the license.
license_price: The price of the license.
license_page_limit: The page limit for the license.

\n","urlObject":{"path":["api","v2","fax","get_number",":number"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"id":"755b1ede-afad-4d96-b17c-1fd37ed25994","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"number"}]}},"response":[{"id":"be4fcd8b-35a6-4221-9124-647107d574b2","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_number/:number","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_number",":number"],"variable":[{"key":"number","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"did\": \"\",\n \"total_pages\": \"\",\n \"license\": \"\",\n \"license_description\": \"\",\n \"license_price\": \"\",\n \"license_page_limit\": \"\"\n}"},{"id":"4a75cc02-bc1a-4e48-a270-0178c2bce1d3","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_number/:number","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_number",":number"],"variable":[{"key":"number","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"c1cc3a78-44fc-403b-a398-e7de437498d3"},{"name":"Get User Info ","id":"f9e77c89-2a04-4ac7-b0a9-24ab0d312a4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_ui/:username","description":"

This HTTP GET request retrieves user interface data for a specific user by their username. The response will include the user's first name, last name, delivery notification settings, non-delivery notification settings, account type, assigned fax numbers, and migration status.

\n","urlObject":{"path":["api","v2","fax","get_ui",":username"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"id":"c057c43c-0db3-4530-9a2c-b4accc43df2f","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"207aa2df-b111-4330-af48-5b7e349ae28c","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_ui/:username","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_ui",":username"],"variable":[{"key":"username","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"username\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"delivery_notification\": \"\",\n \"non_delivery_notification\": \"\",\n \"account_type\": \"\",\n \"assigned_number\": [\n \"\",\n \"\"\n ],\n \"ask_migration\": \"\"\n}"},{"id":"5c6512dc-b49a-4a46-9276-50e343295443","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_ui/:username","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_ui",":username"],"variable":[{"key":"username","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"f9e77c89-2a04-4ac7-b0a9-24ab0d312a4a"},{"name":"Resend Fax ","id":"f2d541f9-6e5b-49f3-8424-70092dc866e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/resend_fax/:uuid","description":"

This API endpoint allows you to resend a fax by providing the UUID of the fax to be resent.

Request

Path Parameters

uuid (string, required): The unique identifier of the fax to be resent.

Response

The response will contain the details of the resent fax, including status and other relevant information.

Example

// Example response for a successful resend\n{\n    \"status\": \"Resend Accepted\",\n    \"message\": \"Fax Queued\",\n    \"uuid\": \"458tyncb-c070-472f-9964-7410a5529f07\"\n}\n\n

","urlObject":{"path":["api","v2","fax","resend_fax",":uuid"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"description":{"content":"

(Required) Unique ID of the fax you want to resend

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"19bd2587-7184-4f49-90c1-d5114264fa8d","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/resend_fax/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","resend_fax",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"Resend Accepted\",\r\n \"message\": \"Fax Queued\",\r\n \"uuid\": \"458tyncb-c070-472f-9964-7410a5529f07\"\r\n}"},{"id":"3e0481fc-8572-4603-95f6-ad6ce1a68c09","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/resend_fax/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","resend_fax",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"f2d541f9-6e5b-49f3-8424-70092dc866e5"},{"name":"Get Cdr ","id":"6d02110c-5bff-4886-b206-a1d1a065301f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_cdr","description":"

This endpoint makes an HTTP GET request to retrieve the call detail records (CDR) for fax transactions. The response will be in JSON format with an array of arrays, where each inner array represents a single CDR entry.

The response for this request will be a status code of 200, indicating a successful retrieval of the CDR. The content type of the response will be \"application/json\".

Here is an example of the response:

[\n    [\n        \"Date\",\n        \"Company\",\n        \"did\",\n        \"faxpages\"\n    ],\n    [\n        \"02-29-2024\",\n        \"company\",\n        \"5555554321\",\n        0\n    ],\n    [\n        \"02-29-2024\",\n        \"company\",\n        \"5555551234\",\n        0\n    ]\n]\n\n

This example shows an empty CDR entry in the response.

\n","urlObject":{"path":["api","v2","fax","get_cdr"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[]}},"response":[{"id":"105ac2ce-f8ec-4b8b-ac20-fcef9cb3f673","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_cdr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\r\n [\r\n \"Date\",\r\n \"Company\",\r\n \"did\",\r\n \"faxpages\"\r\n ],\r\n [\r\n \"02-29-2024\",\r\n \"company\",\r\n \"5555554321\",\r\n 0\r\n ],\r\n [\r\n \"02-29-2024\",\r\n \"company\",\r\n \"5555551234\",\r\n 0\r\n ]\r\n]"}],"_postman_id":"6d02110c-5bff-4886-b206-a1d1a065301f"},{"name":"Get Logs ","id":"f64a6424-f6fc-4f10-a65e-29391ac2f326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myToken"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.mysecurefax.com/api/v2/fax/get_logs/:uuid","description":"

This endpoint retrieves the fax logs for a specific fax with the provided UUID. The HTTP GET request should be made to https://api.mysecurefax.com/api/v2/fax/get_logs/:uuid.

The response will have a status code of 200 and a content type of application/json. The response body will include a \"status\" field and a \"logs\" array, which contains the fax logs.

Here is an example response:

{\n    \"status\": \"\",\n    \"logs\": [\"\"]\n}\n\n

\n","urlObject":{"path":["api","v2","fax","get_logs",":uuid"],"host":["https://api.mysecurefax.com"],"query":[],"variable":[{"description":{"content":"

(Required) Unique ID of the Fax

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"fa166ede-98ca-4109-adcf-44d76eb1bdba","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_logs/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_logs",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"Success\",\r\n \"logs\": [\r\n // Array of related logs\r\n ]\r\n}"},{"id":"a3219ee4-9965-4866-b427-67ab9cdae76a","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.mysecurefax.com/api/v2/fax/get_logs/:uuid","host":["https://api.mysecurefax.com"],"path":["api","v2","fax","get_logs",":uuid"],"variable":[{"key":"uuid","value":"","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"f64a6424-f6fc-4f10-a65e-29391ac2f326"}],"id":"afb68ebd-78bc-4247-a769-602a396f9f10","_postman_id":"afb68ebd-78bc-4247-a769-602a396f9f10","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d84b2e8b-d7c3-4613-90b7-d159b94f044a","id":"d84b2e8b-d7c3-4613-90b7-d159b94f044a","name":"SecureFax v3 API","type":"collection"}}}],"auth":{"type":"inherit","inherit":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"f58489f6-a03f-491c-a077-1c54f0e85bac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7f810788-8622-44ae-8912-448e42685f47","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.mysecurefax.com","type":"string"},{"key":"bearerToken","value":"myToken"}]}