File Exchange
You first need to upload the required images before sending them for auto reading or forgery or any other Signzy AI APIs. Use the file upload system to upload images of ID Cards & documents to get a direct URL.
Upload
Endpoint
POST:: /api/onboardings/upload
Header
Authorization: “your access token” -> You will receive the access token from the Investor login API.
Request data
multipart-form-data with & TTL property
TTL
ttl accepts the following values:(2 mins, 10 mins, 30 mins, 2 hrs, 12 hrs, 7 days, 15 days, 1 month, 3 month, 6 month, 1 year, 3 years, infinity)
When multiple sides or pages of an ID card are required, you need to upload each of them. For example, an Aadhaar card has information on both sides whereas PAN has only the front side containing useful information.
The URLs expire in 30 seconds by default, unless explicitly specified in the inbound request in the TTL parameter.
Expected Response
{
"file": {
"id": 1388,
"filetype": ".......",
"size": 3181,
"directURL": ".......",
"protected": false
}
}The upload returns with the following properties.
- id -> Int (The id of the file)
- filetype -> String (Type of file which was passed into Signzy file system API)
- size -> Int (Size in bytes of the uploaded file)
- directURL -> String (Direct URL using which the file can be accessed.
Download
Endpoint
GET:: /api/onboardings/download
Header
Authorization: “your access token” -> You will receive the access token from the Investor login API.
Request Query
Name | Data Type | Value |
|---|---|---|
q | String | Persist URL(Direct URL) |
Expected Response
Raw File
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].