Get details of a particular document

Get the details of a particular document which tells the details of the document including the status of the document. Use the key “request_status” to check for document completion

API Endpoint

GET https://sign.zoho.com/api/v1/requests/[Request Id]

Request example

curl --location 'https://sign.zoho.com/api/v1/requests/:Request_Id' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \

Response example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "code": 0,
    "requests": {
        "request_status": "completed",
        "notes": "",
        "attachments": [],
        "reminder_period": 5,
        "owner_id": "212541000000010003",
        "description": "",
        "request_name": "NDA policy",
        "modified_time": 1712729617557,
        "action_time": 1712729733535,
        "is_deleted": false,
        "expiration_days": 15,
        "is_sequential": true,
        "sign_submitted_time": 1712729617725,
        "templates_used": [],
        "owner_first_name": "John Zylker",
        "sign_percentage": 100,
        "expire_by": 1714069740000,
        "owner_email": "john.zylker@securesign.com",
        "created_time": 1710743911169,
        "email_reminders": true,
        "document_fields": [
            {
                "document_id": "212541000000244007",
                "fields": []
            }
        ],
        "request_type_name": "Others",
        
        "zsdocumentid": "2C130346-HSSVKF3S3CZ_HZZWYZ7LWSWI1BSQUKRIPI59W8XNLMI",
        "request_type_id": "212541000000000135",
        "owner_last_name": "Zylker",
        "actions": [
            {
                "verify_recipient": false,
                "recipient_countrycode_iso": "",
                "action_type": "SIGN",
                "private_notes": "",
                "cloud_provider_name": "Zoho Sign",
                "recipient_email": "barbara.zylker@securesign.com",
                "language": "en",
                "recipient_phonenumber": "",
                "is_bulk": false,
                "action_id": "212541000000244028",
                "cloud_provider_id": 10,
                "signing_order": 1,
                "fields": [
                    {
                        "field_id": "212541000000247031",
                        "x_coord": 454,
                        "field_type_id": "212541000000000141",
                        "abs_height": 19,
                        "field_category": "image",
                        "field_label": "Signature",
                        "is_mandatory": true,
                        "page_no": 0,
                        "document_id": "212541000000244007",
                        "is_draggable": false,
                        "field_name": "Signature",
                        "y_value": 8.354922,
                        "abs_width": 135,
                        "action_id": "212541000000244028",
                        "width": 22.045263,
                        "y_coord": 66,
                        "field_type_name": "Signature",
                        "description_tooltip": "",
                        "x_value": 74.11568,
                        "is_resizable": true,
                        "height": 2.46114
                    }
                ],
                "recipient_name": "Barbara",
                "delivery_mode": "EMAIL",
                "action_status": "SIGNED",
                "recipient_countrycode": ""           
            }
        ],
        "attachment_size": 0
    },
    "message": "Document has been retrieved",
    "status": "success"
}

Show full

Show less

Request Demo