...
A visual signature can be placed as an image in the signed document. The visual signature is composed by an image and text. SignBox allows to create and store multiple templates.The alias.ini file contains templates with size parameters of each stored image as well as the signature associated text, all represented by an "alias" which is included as a parameter in the SIGN API call.
These are the parameters that you can enable to use this feature:
Parameter | Description | Example | |||||
|---|---|---|---|---|---|---|---|
[alias] | img_bookmark parameter in SIGN Call | uanataca | |||||
x1 | position | Coordinates where you want to place the graphical signature box. Input must follow (x1,y1,x2,y2) , where: x1 belongs to Left X Coordinate (measured from page left side)150 y1 belongs to Bottom Y Coordinate (measured from page bottom) | 80 | x2 belongs to Right X Coordinate (measured from page left side) | 500 | y2 belongs to Top Y Coordinate (measured from page bottom) | 180 |
img | Image argb filename | uanataca.argb | |||||
size_x | Horizontal image size in pt | 512 | |||||
size_y | Vertical image size in pt | 512 | |||||
paragraph_format | Text 300,100,500,150 | ||||||
signature_appearance | Graphical signature details structure. See description | [{ "font" : ["Universal-Bold", 50]... |
Image .argb files must be locateed in the same /img directory where alias.ini is placed. Those files are created from the .png or .jpg files by using the ARGB Tool.
This is how the alias.ini file should look like (three different images are stored in this example):
...
Paragraph format
The signature image permits the addition of identifying text with the signer's associated data. This parameter allows to define the style and the content of the signature image, according to the following JSON object:
| Code Block |
|---|
[{ "font": [< FONTFAMILY >,< FONTSIZE >],"align" : < ALIGNVALUE >, "format": [< LINE1 >,< LINE2 >,...,< LINEN > ]}] |
font (optional): defines the text format to include in the signature image. The parameters < FONTFAMILY > and < FONTSIZE > correspond to the font style and size respectively. The supported styles are the following:
Universal (default): This style belongs to the Sans-Serif category (normal)
Univeral-Bold: Universal font in bold
Univeral-Italic: Universal font in italic
Universal-BoldItalic: Universal font in bold and italic
Times: This style belongs to the Serif category
Times-Bold: Times font in bold
Times-Italic: Times font in italic
Times-BoldItalic: Times font in bold and italic
< FONTSIZE > specifies the character size, defined as points. The sofware adjusts automatically the font size according to the dimensions of the signature image.
align (optional): defines the text alignment related to an image (if exists). It can assume the following values:
right: right text alignment (default)
left: left text alignment
middle: overlapped text
...
<Stack background="iVBORw0KGgoAAAANSUhEUgAAAK8AAACvCAYA"> </Stack> | ||
signature_ids | PDF signature field ids to sign (Example: signature1,signature2) | signature1,signature2 |
Signature appearance
Available tags:
<Grid>
<Stack>
<Paragraph>
Available tag attributes:
background
Available text variables:
$(CN)s : CommonName
$(L)s : Locality
$(S)s : stateOrProvinceName
$(OU)s : organizationalUnitName
$(E)s : email
$(Email)s : email included in the Subject Alternative Name
$(Issuer)s : Certificate CA Issuer Common Name
$(date)s : Date and time of the signature. Compliant to ISO 8601 standard.
$(reason)s : “bit4-reason” parameter value
$(location)s : “bit4-location” parameter value
Example:
| Code Block |
|---|
[{ "font" : [" Universal ",50]," align ":" right","format ": [" Digitally Signed by $(CN)s","O=$(O)s","C=$(C)s","S=$(S)s","Date: $(date)s","CustomField1: CustomValue1 ","CustomField2: CustomValue1 ","CustomField3: CustomValue3 "]}] |
...
...
Webhooks
SignBox API requires that the customer business develop a webhook to manage the service callbacks. There are two callbacks in the service that must be set in the parameters url_out and urlback of the SIGN API call.
...
| Code Block |
|---|
docker compose exec optimizer python -m optimizer generate-rootstore |
Logs
Service logs files are stored in a local folder in OVA or stored inside the containers.To read logs run this commandthe running docker container. You can reach them executing:
| Code Block |
|---|
docker-compose logs |
...
SignBox Postman collection download