| username |
The email address of the account to be used as this signer. The account will only be created automatically if the skin is configured to create accounts on-the-fly. This should *not* include the context id of the QS in use, and so will always be of format user@domain.com. |
| note |
The note to be displayed to this signer during their signing session. This is free format and can be anything. For example: You are the second signer; please review the document. |
| name |
The name of the participant. This is used within the signature block in the signing text and also in any TEXTBOX field that exists in the PDF with the name defined by fieldname. |
| fieldname |
The PDF field name of the form field within the PDF that will have this signers name as defined by "name" field placed within it in a bold italic font, simulating a written signature. - If fieldNameLocations field is empty then if there is already a tag within the PDF with this name, it *must* be of type TEXTBOX else the signing will fail.
- If fieldNameLocations field is not empty then SDX will create a PDF field of type TEXTBOX with this tag name in each of the locations defined.
|
| fieldTBS |
The PDF field name of the form field within the PDF that will have this signers digital signature placed within it. - If fieldTBSLocations field is empty then if there is already a tag within the PDF with this name, and it *must* be of type SIGNATURE else the signing will fail. If no field exists then the PDF will still be signed but no signature block will be bisible within the PDF itself, only in its signature panel.
- If fieldTBSLocations field is not empty then SDX will create a PDF of field type SIGNATURE with this tag name in each of the locations defined.
|
| fieldCompanyName |
The PDF field name of the form field within the PDF that will have this signers company name, as defined by “fieldCompanyNameValue” field placed within it in a bold font. - If fieldCompanyNameLocations field is empty then if there is already a tag within the PDF with this name, and it *must* be of type TEXTBOX else the signing will fail.
- If fieldCompanyNameLocations field is not empty then SDX will create a PDF of field type TEXTBOX with this tag name in each of the locations defined.
|
| fieldCompanyNameValue |
The company name of the participant. This will be used within the any TEXTBOX field that exists in the PDF with the name defined by fieldCompanyName. |
| fieldCompanyNameLocations |
These fields allow the calling system to ask SDX to inject tagged fields into the PDF attachments. The fields themselves correspond to the respective fields naming the tagged fields. The tagged fields that are injected are all of type TEXTBOX apart from the fieldName which is of type SIGNATURE. The format of all these fields is: p,LLX, LLY, URX, URY: p,LLX, LLY, URX, URY. - p is the page within the PDF
- If p is a number then this is the page within the PDF
- If p is set to L then this is the last page of the original PDF
- If p is set to L+1 then this will add a new page to the original PDF and place the field there
- If p is set to L-1 then this will add the field to the last but one page (L-2 etc are supported)
- If p is L+x (where x is a number) then the field will be added to the xth new page at the end of the original document (pages between the last of the original and x will automatically be added if needed)
- LLX is the lower left x position in PDF
- Co-ordinates LLY is the lower left y position in PDF
- Co-ordinates URX is the upper right x position in PDF
- Co-ordinates URY is the upper right y position in PDF
For example, - 1,10, 10, 100, 100:2,10,10,100,100 will add the tagged field to pages 1 and 2 using 10,10, 100, 100 as co-ordinates.
- L,10, 10, 100, 100 will add the tagged field to the last page using 10,10, 100, 100 as co-ordinates.
- L+1,10, 10, 100, 100 will add the tagged field to an additional page using 10,10, 100, 100 as co-ordinates.
The exception is for fieldNameLocations which can only contain ONE block and is a limitation imposed by the PDF standards |
| fieldDate |
The PDF field name of the form field within the PDF that will have the date of the signing placed within it in a bold font, simulating a written date. - If fieldDateLocations field is empty then if there is already a tag within the PDF with this name, and it *must* be of type TEXTBOX else the signing will fail.
- If fieldDateLocations field is not empty then SDX will create a PDF of field type TEXTBOX with this tag name in each of the locations defined.
|
| fieldAudit |
The PDF field name of the form field within the PDF that will have the optional audit log for this signer placed within it in. - If fieldAuditLocations field is empty then if there is already a tag within the PDF with this name, and it *must* be of type TEXTBOX else the signing will fail.
- If fieldAuditLocations field is not empty then SDX will create a PDF of field type TEXTBOX with this tag name in each of the locations defined.
|
| kbacontent |
This is the meta data that will be used by SDX to generate KBA (knowledge based authentication). - If this field is set then SDX will present KBA questions to the signer to prove they are who they say they are. The questions are sourced from third parties but the key data to trigger the questions is provided in this field.
- If it is non-empty then it needs to be of the following format (as one string with no breaks): authengine=vvvv: firstname=nnnn: lastname=llll: fraddr1=aaaa: city=cccc: state=ss: zipcode=xxxxx: Last4=yyyyy.
- vvvv is the authentication engine to use (veratad is only engine in 2012 release),
- nnnn is the first name of the signer,
- llll is the last name of the signer,
- aaaa is the first line of the home address of the signer,
- cccc is the city of the signer,
- ss is the state that the signer lives in,
- zipcode is the home zipcode of the signer, and
- yyyy is the last 4 digits of the signers SSN.
|
