SignRequest

Parameters

Name	Type	Description	Requirement
id	Integer	The sign request identifier	Required
name	String	The sign request name	Required
status	String	The sign request status. Possible values: draft, sent, completed, declined	Required
formType	String	The type of the sign request. Possible values: Form, Document	Required
participants	Array	An array of Participant objects associated with the sign request	Optional
savedTime	String	The time the sign request was last saved	Required
fields	Array	An array of Field objects associated with the sign request	Optional

Example Response

JSON

{
    "id": 374,
    "name": "Document #33",
    "status": "Completed",
    "formType": "Document",
    "participants": [
        {
            "id": 379,
            "name": "John Smith",
            "email": "[email protected]",
            "status": "Signed",
            "role": {
                "id": 497,
                "name": "Employee",
                "sequence": 0
            },
            "fieldData": [
                {
                    "id": 389,
                    "fieldId": 1185,
                    "imageContent": "iVBORw0KGgoAAAANSUhEUgAAAbkAAAC1CAYAA...ggg==",
                    "imageMimetype": "image/png"
                }
            ]
        }
    ],
    "savedTime": "2022-02-02 10:08:23",
    "fields": [
        {
            "id": 1185,
            "roleId": 497,
            "required": true,
            "isMasked": false,
            "type": "signature"
        }
    ]
}