Base64 Persist File Upload API

Introduction

This API empowers you to seamlessly convert images/pdf in Base64 format into image/pdf files hosted on the cloud, providing you with a Persist URL for convenient access. This URL can be used in the request packet of other Signzy APIs to process ID cards, documents, or any other image data. Thus, it simplifies the conversion process, offering flexibility and reliability.

Key Features:

Base64 to Image Conversion:
Easily transform Base64-encoded images into standard image files.
Cloud Hosting:
Your converted images are securely hosted on the cloud, ensuring accessibility and reliability.
Temporary URL Generation:
Instantly receive a URL for your converted image, valid for a specified duration.
Customizable Expiry:
Control the expiration time of the URL by specifying the Time-To-Live (TTL) parameter.

API details

Endpoint

POST https://api.signzy.app/api/v3/persist/base64

POST https://api-preproduction.signzy.app/api/base64

Request body parameters

Parameter	Data Type	Description	Required
base64String	String	base64 string that needs to be converted	Mandatory
mimetype	String	'image/jpeg', 'image/png', 'image/jpg', 'application/pdf', 'image/tiff'	Mandatory
ttl	String	Time to live for your file. The default value is 30 secs in its NA/Invalid. Sample input format: 2 mins, 13 mins, 38 mins, 2 hrs, 12 hrs, 24 hrs, 7 days, 66 days, 1 month, 3 months, 6 months, 1 year, 3 years, infinity	Optional

{
    "base64String":"",
    "mimetype":"",
    "ttl":""
}

Request Headers

Name	Value	Required	Description
Content-type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Code Samples

curl --location 'https://api.signzy.app/api/v3/persist/base64' \
--header 'Content-Type: application/json' \
--header 'Authorization: xxxxxxxxxxxxxxxxxxxxxxx' \
--data '{"base64String":"","mimetype":"","ttl":""}'

Response body parameters

Parameter	Data Type	Description
file	Object	The root object contains the result of the operation.
id	String	ID of the file.
fileType	String	mimetype
size	String	Size of the file. (It should be less than 10 Mb in base64String)
directURL	String	Persist link to the image which will be used in other API requests.

{
      "file": {
        "id": "...id...",
        "filetype": "...mimeType...",
        "size": size,
        "directURL": "https://persist.signzy.tech/api/base64strings/...id.../download/...name...",
      }
}

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!