Persist - persist.signzy.tech
7 min
You first need to upload the required images before sending for auto reading. Use the file upload system, persist.signzy.tech, to upload images of ID Cards & documents to get a direct URL.
When multiple sides or pages of an ID card are required, you need to upload each of them. For example Aadhaar card has information on both sides whereas PAN has only front side containing useful information.
The URLs expire in 30 seconds by default, unless explicitly specified in the inbound request in the ttl parameter.
If given ttl is just t number without units (e.g., 45), file expiry time will be set to t seconds (or, 45 seconds in this case)
ttl: Accepts the following values but not limited to: (2 mins, 13 mins, 38 mins, 2 hrs, 12 hrs, 24 hrs, 7 days, 66 days, 1 month, 3 month, 6 month, 1 year, 3 years, infinity). Default value, if invalid ttl is passed is 30 secs.
- ttl accepts the following units: (sec(s),min(s), hr(s), day(s), month(s), year(s)) and infinity
- some good examples of ttl: (10 mins, 1 day, 44 secs, 15, infinity)
Multipart form data based file upload
For Test Credentials
// POST :: https://preproduction-persist.signzy.tech/api/files/upload
For Production Credentials
// POST :: https://persist.signzy.tech/api/files/upload
// Request data :: multipart-form-data with & optional text properties ttl, optimize and key
// ttl accepts the following units: (sec(s),min(s), hr(s), day(s), month(s), year(s)) and infinity
// Some good examples of ttl: (10 mins, 1 day, 44 secs, 15, infinity)
// optimize true reduces the size of the file before uploading, only images are supported with the optimize property
// key is an alphanumeric string which can be used to protect the file. The file will not be downloaded without passing the correct key
// File size limit is 100Mb
// If multiple parameters with the same name are passed/uploaded, the first ones are considered
// Expected Test response
{
"file": {
"id": "...id...",
"filetype": "...mimeType...",
"size": size,
"directURL": "https://preproduction-persist.signzy.tech/api/files/...id.../download/...name...",
"protected": true/false
}
}
// Expected Production response
{
"file": {
"id": "...id...",
"filetype": "...mimeType...",
"size": size,
"directURL": "https://persist.signzy.tech/api/files/...id.../download/...name...",
"protected": true/false
}
}
Base64 based - form data file upload
Input parameters
Form data should have the following parameters.
- base64string : 'base64 of the file'
- mimetype: : 'mime type e.g. (image/jpeg)'
- ttl: Accepts the following values but not limited to: (2 mins, 13 mins, 38 mins, 2 hrs, 12 hrs, 24 hrs, 7 days, 66 days, 1 month, 3 month, 6 month, 1 year, 3 years, infinity). Default value, if invalid ttl is passed is 30 secs.
- ttl accepts the following units: (sec(s),min(s), hr(s), day(s), month(s), year(s)) and infinity
- some good examples of ttl: (10 mins, 1 day, 44 secs, 15, infinity)
For Test Credentials
// POST :: https://preproduction-persist.signzy.tech/api/base64strings/upload
For Production Credentials
// POST :: https://persist.signzy.tech/api/base64strings/upload
// base64string : 'base64 of the file'
// Request data :: multipart-form-data with & optional text properties ttl, optimize and key
// mimetype: : 'mime type possible types: (image/jpeg, image/png, image/jpg, application/pdf)'
// ttl accepts the following units: (sec(s),min(s), hr(s), day(s), month(s), year(s)) and infinity
// Some good examples of ttl: (10 mins, 1 day, 44 secs, 15, infinity)
// key is an alphanumeric string which can be used to protect the file. The file will not be downloaded without passing the correct key
// File size limit is 100Mb
// If multiple parameters with the same name are passed/uploaded, the first ones are considered
// Expected Test response
{
"file": {
"id": "...id...",
"filetype": "...mimeType...",
"size": size,
"directURL": "https://preproduction-persist.signzy.tech/api/base64strings/...id.../download/...name...",
"protected": true/false
}
}
// Expected Production response
{
"file": {
"id": "...id...",
"filetype": "...mimeType...",
"size": size,
"directURL": "https://persist.signzy.tech/api/base64strings/...id.../download/...name...",
"protected": true/false
}
}
Base64 JSON based file upload
Input parameters
JSON POST request with the following parameters as part of input
- base64String : 'base64 of the file with 100Mb size limit'
- mimetype: : 'mime type possible types: (image/jpeg, image/png, image/jpg, application/pdf)'
- ttl: Accepts the following values but not limited to: (2 mins, 13 mins, 38 mins, 2 hrs, 12 hrs, 24 hrs, 7 days, 66 days, 1 month, 3 month, 6 month, 1 year, 3 years, infinity). Default value, if invalid ttl is passed is 30 secs.
- ttl accepts the following units: (sec(s),min(s), hr(s), day(s), month(s), year(s)) and infinity
- some good examples of ttl: (10 mins, 1 day, 44 secs, 15, infinity)
For Test Environment
// POST :: https://preproduction-persist.signzy.tech/api/base64
For Production En
// POST :: https://persist.signzy.tech/api/base64
// base64String : 'base64 of the file'
// mimetype: : 'mime type possible types: (image/jpeg, image/png, image/jpg, application/pdf)'
// ttl: Accepts the following values: (2 mins, 10 mins, 30 mins, 2 hrs, 12 hrs, 24 hrs, 7 days, 15 days, 1 month, 3 month, 6 month, 1 year, 3 years, infinity). Default value, if invalid ttl is passed is 30 secs.
// File size limit is 100Mb
// key is an alphanumeric string which can be used to protect the file. The file will not be downloaded without passing the correct key
// Expected Test response
{
"file": {
"id": "...id...",
"filetype": "...mimeType...",
"size": size,
"directURL": "https://preproduction-persist.signzy.tech/api/files/...id.../download/...name...",
"protected": true/false
}
}
// Expected Production response
{
"file": {
"id": "...id...",
"filetype": "...mimeType...",
"size": size,
"directURL": "https://persist.signzy.tech/api/files/...id.../download/...name...",
"protected": true/false
}
}
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].