Persist API specifications

Signzy's file hosting service called Persist allows clients to upload files and obtain a direct URL to the file. Clients can use this URL as input to Signzy's APIs that work on documents and files to perform tasks such as OCR, Face Match, PDF Conversions, and Document Templators and Document Signing.

By incorporating the Persist API into your application , you can ensure seamless integration with Signzy's API Stack , providing a reliable and secure data storage solution.

Production Environment

Request Data:

Note: If multiple parameters with the same name are passed/uploaded, the first ones are considered.

The file parameter is mandatory and must be included in the API call. The ttl, optimize, and key parameters are optional.

The file parameter is a required parameter in the Signzy API for uploading files to Signzy's Persist file system. The file to be uploaded should be included in the request as part of the multipart/form-data format.

The file parameter should be included in the request with the key file and the value set to the file to be uploaded. The file should be of type File and not empty. The maximum file size limit for the upload is 100MB.

Note that if multiple parameters with the same name are passed or uploaded, the first ones are considered. Therefore, it is important to ensure that the file parameter is included as the first parameter in the request.

When the file is uploaded successfully, the API will return a JSON response containing information about the uploaded file, including the unique identifier of the file (id), the MIME type of the file (filetype), the size of the file in bytes (size), the URL to access the file (directURL), and whether the file is password protected (protected).

The ttl parameter sets the time to live for the file. By default, the URL to the file expires in 30 seconds. The ttl parameter accepts units such as seconds, minutes, hours, days, months, years, and infinity. If a value is provided for ttl without any units, e.g., 45, the file expiry time will be set to 45 seconds.

The ttl parameter in Signzy's file system is used to specify the time to live for the uploaded file. It determines the expiration time for the directURL provided in the response.

The ttl parameter accepts time units such as seconds, minutes, hours, days, months, years, and infinity. The units are represented as sec(s), min(s), hr(s), day(s), month(s), year(s), respectively.

Some examples of ttl are:

By default, the ttl is set to 30 seconds if not explicitly specified in the request. If the ttl parameter is specified without any units, e.g., 45, the file expiry time will be set to 45 seconds.

In summary, the ttl parameter provides flexibility to control the expiration time of the file URL and helps to ensure the security of the uploaded file.

When a user sends a multipart/form-data request to upload a file to Signzy's Persist file system and the request is processed successfully, the API responds with the following success message:

This success message indicates that the file upload was successful. The id field in the response represents the unique identifier of the uploaded file, while the filetype field represents the MIME type of the file. The size field represents the size of the uploaded file in bytes.

The directURL field represents the URL that can be used to access the uploaded file. This URL can be used as input to Signzy's APIs for tasks such as OCR, face match, PDF conversions, and document signing. The protected field indicates whether the file is password protected or not.

Note that the directURL expires in 30 seconds by default, unless explicitly specified in the inbound request using the ttl parameter. If the ttl parameter is specified without any units, e.g., 45, the file expiry time will be set to 45 seconds. The file size limit is 100MB.

To access the uploaded file, the user can simply follow the directURL provided in the response.

When a user sends a multipart/form-data request to upload a file to Signzy's Persist file system without providing the file parameter, the API responds with the following error:

This error message indicates that the user has not included a file to be uploaded in their request. The status field in the error response is set to 422, indicating that the request was well-formed but could not be processed due to invalid parameters. The type field is set to "Error" to indicate that an error has occurred.

The statusCode field is also set to 422 to indicate the HTTP status code of the error response. The code field is set to "FILE_REQUIRED" to indicate that the error occurred due to the file parameter being missing in the request. The message field provides a user-friendly explanation of the error and advises the user to consult the documentation and create a properly formatted request.

To troubleshoot this error, the user should check their multipart/form-data request and ensure that the file parameter is included and contains the file to be uploaded. The file parameter should be of type File and not empty.

If the file parameter is present in the request but the error still persists, the user should check the file size and ensure that it does not exceed the 100MB limit imposed by Signzy's Persist file system. Additionally, the user can check the documentation for additional troubleshooting steps or contact Signzy's support team for further assistance.



Signzy's Persist file system supports a wide range of file formats for uploading files. The supported file formats include:

Note that while these file formats are supported, certain Signzy APIs may only be compatible with specific file formats. It's important to ensure that the file format being uploaded is compatible with the intended use case before uploading the file.

Additionally, the maximum file size limit for the upload is 100MB, regardless of the file format. If a file exceeds this limit, the API will return an error indicating that the file is too large to be uploaded.

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!