Name | Type | Description | Notes |
---|---|---|---|
file | String | File id reference | |
page | Integer | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional] |
position | String | Coordinates of the signature image to set. Format is : "llx,lly,urx,ury". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional] |
field_name | String | [type=signature] Name of the signature field existing in the document, it will be not used on the signature image. | [optional] |
mention | String | [type=signature] Text associated above the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] |
mention2 | String | [type=signature] Text associated below the signature image. (internal usage only, should not be used). You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] |
member | String | Member id reference | [optional] |
reason | String | [type=signature] The reason they are signing the agreement | [optional] [default to 'Signed by Yousign'] |
type | String | The type of the file object | [optional] [default to 'signature'] |
content_required | BOOLEAN | [type=text] Indicate if the member must fill or not the field | [optional] [default to false] |
content | String | [type=text] The content of the field. Could be used for placeholder | [optional] |
font_family | String | [type=text] The font familly used to render the TextField. Currently only the default value will be used. | [optional] [default to 'raleway'] |
font_size | Integer | [type=text] The font size used to render the field. Currently only the default value will be used. | [optional] [default to 12] |
font_color | String | [type=text] The font color used to render the field. | [optional] |