Attachments
Viafirma Documents new module allows you to attach images and PDF files, audios and videos that will be attached to your requests.
Unlike the use of the signature and evidence module, attachments will not be reflected in the document, but are only incorporated into the registry, being linked to the document to simplify its further management..
In addition, the built-in attachments are prepared to add business logic to them, from ad-hoc implementations that are incorporated into the system, allowing for the validation of attached documents through an external web service, e.g., ID validation, invoice validation, etc.
Setup and use
This feature enables you to configure your policies with attachments in two ways: through the policy builder from your templates, or directly in the service definition when using it via API.
Setup from backend
In templates, the policy module allows you to add and configure the different types of supported attachments through advanced options
You can choose between: VIDEO, AUDIO, IMAGE and PDF.
Remember that you DO NOT have to set up any position on the document.
Use with API
The policy configuration must include attachments, choosing the desired attachment type.
"policies" : [ { "evidences" : [ {…} ] } ], "signatures" : [ {…} ] } ], "attachments" : [ { "type" : "VIDEO|AUDIO|IMAGE|PDF", "helpText" : "string", "helpDetail" : "string", “optional” : boolean } ] } ]
JSON Example
Once the process is finished, your attachment will incorporate metadata to help you in your work.
"attachments" : [ {
"type" : "VIDEO|AUDIO|IMAGE|PDF",
"status" : "PENDING|RECEIVED",
"helpText" : "string",
"helpDetail" : "string",
“optional” : boolean,
"date" : miliseconds,
"hash" : "sha256 string"
} ]
Once the signing process is completed, you will be able to access the request details, as well as downloadable attachments.
ADVANCED USE. Processing Attachments
The attachment module is designed to integrate services that process attachments for future versions.
For instance, you will be able to set up “OCR” processing to analyze an attached bank statement in PDF format, where the holder’s name and account number would be processed. This could also be used for validating images, for example, validating a passport or for face recognitio n.
To do this, you can use the processType and processid features that will help you identify the provider and service type to be used, using metadataList, where you can add the necessary configuration parameters for each case.
"attachments": [{
"type": " VIDEO|AUDIO|IMAGE|PDF ",
"code": "string",
"status": " PENDING|RECEIVED ",
"helpText": "string",
"helpDetail": "string",
"optional": booelan,
"date": milliseconds,
"hash": "string sha256",
"processType": "string",
"processId": "string",
"metadataList": [
{
"key": "string",
"value": "string"
}
]
}]
Check out the implementations and types of services for processing attachments included in your Viafirma Documents version.
Should you have any questions, please contact us to: helpdesk@viafirma.com