Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.74 KB

FileObjectOutput.md

File metadata and controls

19 lines (15 loc) · 1.74 KB

FileObjectOutput

Properties

Name Type Description Notes
id string Id of the object [optional]
file \YouSign\Client\Model\FileOutput
page int 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 Name of the signature field existing in the document [optional]
mention string 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__internal string Text associated below 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]
created_at \DateTime Created date of the object [optional]
updated_at \DateTime Updated date of the object [optional]
executed_at \DateTime Date of signature or validation [optional]

[Back to Model list] [Back to API list] [Back to README]