FaxSIPit API
HomeGithub
HomeGithub
Support
Login
  1. Generic-Fax-API
  • Generic-Fax-API
    • Test Connection
      GET
    • Sign in - with username/password
      POST
    • Verify Token
      POST
    • Get Cover Page List
      GET
    • Send a Fax
      POST
    • Get Sent Status
      GET
    • New Received Count
      GET
    • Get Received Faxes
      GET
    • Get Sending Faxes
      GET
    • Get Sent Faxes
      GET
    • Preview Fax
      POST
    • Download Fax
      POST
    • Get User Info
      GET
    • Get User Fax Numbers
      GET
    • Refresh Token
      GET
  • Untitled Endpoint
    GET
  1. Generic-Fax-API

Download Fax

POST
https://portal-fax-api.faxsipit.com/api/endpoint/download-fax
Download a fax by providing its details. If the status of the fax is 'New' or 'Read', then it changes the status of the fax to 'Downloaded' on the server.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/x-www-form-urlencoded

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://portal-fax-api.faxsipit.com/api/endpoint/download-fax' \
--header 'Authorization: Bearer <token>' \
--data-urlencode 'ref_code=20250606192741_7782220009_7782220009_710' \
--data-urlencode 'is_send=0' \
--data-urlencode 'creation_time=1749238036'

Responses

🟢200Success
application/json
Body

Example
{
    "ref_code": "20250710151803_7787244652_9107143295_156",
    "fax_data": "JVBERi0xLjUNCiXi48/TDQo3IDAgb2JqDQo8PC9EWzIgMCBSL0ZpdF0vUy9Hb1RvPj4NCmVuZG9iag0KOCAwIG9iag0KPDwvQ3JlYXRvcihOZWV2aWEgREMgUHJvIC0gSU1BR0UvT0NSIHBhcnNlcikvUHJvZHVjZXIoTmVldmlhIERvY3VtZW50IENvbnZlcnRlciBQcm8gdjcuMi4wLjE0NiBcKGh0dHA6Ly9uZWV2aWEuY29tXCkpL0NyZWF0aW9uRGF0ZShEOjIwMjUwNzEwMTUxODA3KzAwJzAwJykvTW9kRGF0ZShEOjIwMjUwNzEwMTUxODA3KzAwJzAwJyk+Pg0KZW5kb2JqDQo1IDAgb2JqDQo8PC9UeXBlL1BhZ2VzL1BhcmVudCAzIDAgUi9LaWRzWzIgMCBSXS9Db3VudCAxPj4NCmVuZG9iag0KMyAwIG9iag0KPDwvQ291bnQgMS9UeXBlL1BhZ2VzL0tpZHNbNSAwIFJdPj4NCmVuZG9iag0KMTAgMCBvYmoNCjw8L0xlbmd0aCAxNjk2L1R5cGUvTWV0YWRhdGEvU3VidHlwZS9YTUw+PnN0cmVhbQ0KPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPD9hZG9iZS14YXAtZmlsdGVycyBlc2M9IkNSTEYiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLycgeDp4bXB0az0nMy4xLTcwMic+CjxyZGY6UkRGIHhtbG5zOnJkZj0naHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyc+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSdCNUU5MkM2NC1BRTBELTFDMjUtOTcwQy1GMUEyNUIxRkZEQjEnIHhtbG5zOnBkZj0naHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyc+PHBkZjpLZXl3b3Jkcz48L3BkZjpLZXl3b3Jkcz48cGRmOlByb2R1Y2VyPk5lZXZpYSBEb2N1bWVudCBDb252ZXJ0ZXIgUHJvIHY3LjIuMC4xNDYgKGh0dHA6Ly9uZWV2aWEuY29tKTwvcGRmOlByb2R1Y2VyPjwvcmRmOkRlc2NyaXB0aW9uPgo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0nQjVFOTJDNjQtQUUwRC0xQzI1LTk3MEMtRjFBMjVCMUZGREIxJyB4bWxuczp4bXA9J2h0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8nPjx4bXA6TW9kaWZ5RGF0ZT4yMDI1LTA3LTEwVDE1OjE4OjA3KzAwOjAwPC94bXA6TW9kaWZ5RGF0ZT48eG1wOkNyZWF0ZURhdGU+MjAyNS0wNy0xMFQxNToxODowNyswMDowMDwveG1wOkNyZWF0ZURhdGU+PHhtcDpNZXRhZGF0YURhdGU+MjAyNS0wNy0xMFQxNToxODowNyswMDowMDwveG1wOk1ldGFkYXRhRGF0ZT48eG1wOkNyZWF0b3JUb29sPk5lZXZpYSBEQyBQcm8gLSBJTUFHRS9PQ1IgcGFyc2VyPC94bXA6Q3JlYXRvclRvb2w+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSdCNUU5MkM2NC1BRTBELTFDMjUtOTcwQy1GMUEyNUIxRkZEQjEnIHhtbG5zOmRjPSdodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyc+PGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD48ZGM6ZGVzY3JpcHRpb24+PHJkZjpBbHQ+PHJkZjpsaSB4bWw6bGFuZz0neC1kZWZhdWx0Jz48L3JkZjpsaT48L3JkZjpBbHQ+PC9kYzpkZXNjcmlwdGlvbj48ZGM6Y3JlYXRvcj48cmRmOlNlcT48cmRmOmxpPjwvcmRmOmxpPjwvcmRmOlNlcT48L2RjOmNyZWF0b3I+PGRjOnRpdGxlPjxyZGY6QWx0PjxyZGY6bGkgeG1sOmxhbmc9J3gtZGVmYXVsdCc+PC9yZGY6bGk+PC9yZGY6QWx0PjwvZGM6dGl0bGU+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSdCNUU5MkM2NC1BRTBELTFDMjUtOTcwQy1GMUEyNUIxRkZEQjEnIHhtbG5zOnhtcE1NPSdodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vJz48eG1wTU06RG9jdW1lbnRJRD51dWlkOkNBMzE4QUYwLTNEMjgtMUM4MS0xNEJCLUVCMDJGNEFDMEQyMjwveG1wTU06RG9jdW1lbnRJRD48eG1wTU06SW5zdGFuY2VJRD51dWlkOkI1RTkyQzY0LUFFMEQtMUMyNS05NzBDLUYxQTI1QjFGRkRCMTwveG1wTU06SW5zdGFuY2VJRD48L3JkZjpEZXNjcmlwdGlvbj4KCjwvcmRmOlJERj4KPC94OnhtcG1ldGE+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKPD94cGFja2V0IGVuZD0ndyc/Pg0KZW5kc3RyZWFtDQplbmRvYmoNCjkgMCBvYmoNCjw8L09wZW5BY3Rpb24gNyAwIFIvVHlwZS9DYXRhbG9nL1BhZ2VzIDMgMCBSL01ldGFkYXRhIDEwIDAgUj4+DQplbmRvYmoNCjEgMCBvYmoNCjw8L1R5cGUvWE9iamVjdC9TdWJ0eXBlL0ltYWdlL0RlY29kZVBhcm1zPDwvSyAtMS9Db2x1bW5zIDE3MjgvUm93cyAyMjAwPj4vQ29sb3JTcGFjZS9EZXZpY2VHcmF5L0ZpbHRlci9DQ0lUVEZheERlY29kZS9XaWR0aCAxNzI4L0hlaWdodCAyMjAwL0xlbmd0aCAxMDg4L0JpdHNQZXJDb21wb25lbnQgMT4+c3RyZWFtDQrnZqELQqBCylYpGZoyIZ8iWMl8+KdlGVsin/+mnp/r53O9nzPcFRnaM7nBDOwWe4LOI//H6en6fH//44P4/4Pg+Dxx0v//S/5oeaMjx4zZke///zxGzI8SiI7yCGERRnpn/L8WnFnv/WDtT/9xcXp/0aHxhmejQ53O//0rYr8o53O9mh6NDDOE+n+hp/9I8L+bFSnd/pf9P0//+d////+kLozv/////44//jj+KXTj5mX///////9L/1//////+l/X+kjR////57//z3//5/+v/////////////nv//a/2v/9rk+tr/r/a/a/CDYrQMIi4Ku78EDYqRbFMVggfF3dxWCBsUERagfaH2vx9raaH2WP/nHXtfERERERERERERERxEREf6D8f///ndhyfJRHY3lbyVCnYMKTkdkkZUjVkkBc2ytslV/9b//+d0/+fY0fmSP+fD5Dh/4/7eI////9////////8EQ4ESqIxzmCKNEOcihkY5/IcCIeZFOTsmpfOopQKdBkfNBSNEdSLx5kcZIGSGRyNBSNECIcF/kcZQKTsjjzBE4yP/9DT00P0/1000NPT4tOLT8cYtOL9D+DOU0bs/MGfU3NG6DOUnDPzDTC0tG5z80bqNzIlo1igzc0bGGXdG5kSwZ0vLxz8wzc+CRu/+nF9Jun8XbSitJsXp0m9J6dJuFpN/wnF6fSp//j9Pj+2lXT+NPpP6TeNP//+li1/b/2/2KnL/2/6f6f///4pv/yKNeORQ+dAjXxmYSRaD//+P/zQJ9SLV/sNfYfqn+rD/////X7YY/yEkb/OBP0b6BF/505vkZTlv//nLf+jf+yDv71+/1pNnS/rf7X7X/Iy/r+d2/8h//Zpn//0m/7NPzT7NPbX20uzT///9sn/2e+1tOz22trZ77TSb/bW07VtdtfbS217Pf/af7dqSKd2HYyTDxTFsbFRTGUgdiwgwg8IikEPQUxcUxRMB2IIj4QYQbFGgdiiYDseRMIEGEGxYQYQYWDivtc46ZG9pqcdNbI3+PtMjfOOmtr9ra2h/ZG//nHXERERERERERERERERERxERERERERERER9aUtBAmo//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////gAgAg0KZW5kc3RyZWFtDQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZS9SZXNvdXJjZXM8PC9Qcm9jU2V0Wy9QREYvVGV4dC9JbWFnZUJdL1hPYmplY3QgNiAwIFI+Pi9Db250ZW50cyA0IDAgUi9QYXJlbnQgNSAwIFIvTWVkaWFCb3hbMCAwIDYxMCA4MDhdPj4NCmVuZG9iag0KNCAwIG9iag0KPDwvTGVuZ3RoIDQxPj5zdHJlYW0NCnEKNjEwIDAgMCA4MDggMCAwIGNtCi9JbTE1MTg3NTY0NTA2IERvClEKDQplbmRzdHJlYW0NCmVuZG9iag0KNiAwIG9iag0KPDwvSW0xNTE4NzU2NDUwNiAxIDAgUj4+DQplbmRvYmoNCnhyZWYNCjAgMTENCjAwMDAwMDAwMDAgNjU1MzUgZg0KMDAwMDAwMjI0OCAwMDAwMCBuDQowMDAwMDAzNTQ3IDAwMDAwIG4NCjAwMDAwMDAzMzYgMDAwMDAgbg0KMDAwMDAwMzY4NCAwMDAwMCBuDQowMDAwMDAwMjY5IDAwMDAwIG4NCjAwMDAwMDM3NzcgMDAwMDAgbg0KMDAwMDAwMDAxNyAwMDAwMCBuDQowMDAwMDAwMDYwIDAwMDAwIG4NCjAwMDAwMDIxNjcgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDkgMCBSDQovSW5mbyA4IDAgUg0KL0lEIFs8RTlCNzY2QkVFNTM0NEZDMEYxMEFERkNBMjQ4MjM2NjI+PDVFREY3MzI3NDBENDIxNkY2N0VGQTMxOEJDQjgxMjMwPl0NCj4+DQpzdGFydHhyZWYNCjM4MjANCiUlRU9GDQo=",
    "code": 1
}
🟢200fail
Previous
Preview Fax
Next
Get User Info
Built with