Migrating Signature Request with fields payload

Customers using the Signature Request API with the fields payload can migrate to the v2 APIs using the following endpoints.

The v2 API now supports sending multiple documents for signature in a single request.

Sending the Signature Request

POST /v1/files/pending/fields/

{
  "recipients": [{
     "email": "[email protected]",
     "first_name": "Prashanth",
     "last_name": "Raghu"
  }
  ],
  "message": "Offer letter",
  "is_ordered": 0,
  "name": "Offer letter - Prashanth",
  "cc": [{"email": "[email protected]"}],
  "original_file_id": 22322123,
  "embedded_signing": true,
  "fields_payload": {
              "email": "[email protected]",
              "type" : "text",
              "required" : true,
              "page_number" : 2,
              "x" : 300.0,
              "y" : 600.0,
              "height" : 50,
              "width" : 100,
              "additional_info" : {}
           },
           {
             "email" : "[email protected]",
             "type" : "text",
             "required" : true,
             "page_number" : 2,
             "x" : 100.0,
             "y" : 200.0,
             "height" : 50,
             "width" : 100,
             "additional_info" : {}
           }
}
POST /v2/rs/envelope/

{
  "recipients": [{
     "email": "[email protected]",
     "first_name": "Prashanth",
     "last_name": "Raghu",
     "recipient_id": 1
  }
  ],
  "message": "Offer letter",
  "is_ordered": 0,
  "name": "Offer letter - Prashanth",
  "cc": [{"email": "[email protected]"}],
  "embedded_signing": true,
  "originals": [
    {
     "id": 22322123,
     "name": "Offer letter - Prashanth"
    }
  ]
  "fields_payload": {
              "original_id": 22322123,
            "recipient_id": 1,
              "type" : "text",
              "required" : true,
              "page_number" : 2,
              "x" : 300.0,
              "y" : 600.0,
              "height" : 50,
              "width" : 100,
              "additional_info" : {}
           },
           {
             "original_id": 22322123,
           "recipient_id": 1,
             "required" : true,
             "page_number" : 2,
             "x" : 100.0,
             "y" : 200.0,
             "height" : 50,
             "width" : 100,
             "additional_info" : {}
           }
}

Fetch information about the pending file

GET /v1/files/pending/<file_id>

{
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 0,
            "id": 235644,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Prashanth.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557465369,
                    "email": "[email protected]",
                    "first_name": "Prashanth",
                    "last_modified_time": 1591780421,
                    "last_name": "Raghu",
                    "order_id": 1,
                    "recipient_id": 377928,
                    "recipient_user_id": 3625901,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        }
GET /v2/rs/envelope/<file_id>

{
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 0,
            "id": 235644,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Prashanth.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "sources": [{
               "id": 22322123,
               "name": "Offer letter - Prashanth"
            }]
            "recipients": [
                {
                    "created_time": 1557465369,
                    "email": "[email protected]",
                    "first_name": "Prashanth",
                    "last_modified_time": 1591780421,
                    "last_name": "Raghu",
                    "order_id": 1,
                    "recipient_id": 377928,
                    "recipient_user_id": 3625901,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        }

List all Signature requests

GET /v2/rs/envelope

{
   "count": 2,
   "files":[
      {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 1,
            "id": 235644,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Prashanth.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557465369,
                    "email": "[email protected]",
                    "first_name": "Prashanth",
                    "last_modified_time": 1591780421,
                    "last_name": "Raghu",
                    "order_id": 1,
                    "recipient_id": 377928,
                    "recipient_user_id": 3625901,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        },
        {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 0,
            "id": 235666,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Anirjit.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557422123,
                    "email": "[email protected]",
                    "first_name": "Anirjit",
                    "last_modified_time": 1591780425,
                    "last_name": "Bakshi",
                    "order_id": 1,
                    "recipient_id": 377929,
                    "recipient_user_id": 3625921,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        }
   ]
}

Remind all signers of the Signature Request

POST /v1/files/pending/<file_id>/remind
POST /v2/rs/envelope/<file_id>/remind

Cancel the Signature Request

POST /v1/files/pending/<file_id>/cancel
POST /v2/rs/envelope/<file_id>/cancel

Retrieve the Completed Signature Request details

GET /v1/files/signed/<signed_file_id>
GET /v2/rs/envelope/signed/<signed_file_id>

Retrieve all Completed Signature Requests

GET /v1/files/signed

{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": null,
            "checksum": "37d1a91062553e4602880e675c4d1f9d1c1f407e084c9d7866d2b3b8b248f174",
            "created_time": 1557731017,
            "fa_aadhaar_enabled": null,
            "id": 14845678,
            "last_modified_time": 1557731017,
            "name": "Offer letter - Prashanth.pdf",
            "pending_file": {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 1,
            "id": 235641,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Prashanth.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557465369,
                    "email": "[email protected]",
                    "first_name": "Prashanth",
                    "last_modified_time": 1591780421,
                    "last_name": "Raghu",
                    "order_id": 1,
                    "recipient_id": 377928,
                    "recipient_user_id": 3625901,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        },
            "public_identifier": "pNovCTn7_nQ5imZW6_Nhgw=="
        },
        {
            "aadhaar_enabled": null,
            "checksum": "e3c10aa1faf10d6feab10f348790bcda1fbb4f0ba2a1151f8a9d92e3fc263d14",
            "created_time": 1557731210,
            "fa_aadhaar_enabled": null,
            "id": 14845680,
            "last_modified_time": 1557731210,
            "name": "Offer letter - Anirjit.pdf",
            "pending_file": {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 1,
            "id": 235641,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Anirjit.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557422123,
                    "email": "[email protected]",
                    "first_name": "Anirjit",
                    "last_modified_time": 1591780425,
                    "last_name": "Bakshi",
                    "order_id": 1,
                    "recipient_id": 377929,
                    "recipient_user_id": 3625921,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        },
            "public_identifier": "ip_dRR0POvdI9cQgwbPqcg=="
        }
 ]
GET /v2/rs/envelope/signed/

{
    "count": 2,
    "files": [
        {
            "aadhaar_enabled": null,
            "checksum": "37d1a91062553e4602880e675c4d1f9d1c1f407e084c9d7866d2b3b8b248f174",
            "created_time": 1557731017,
            "fa_aadhaar_enabled": null,
            "id": 14845678,
            "last_modified_time": 1557731017,
            "name": "Offer letter - Prashanth.pdf",
            "pending_file": {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 1,
            "is_envelope": 1,
            "id": 235641,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Prashanth.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557465369,
                    "email": "[email protected]",
                    "first_name": "Prashanth",
                    "last_modified_time": 1591780421,
                    "last_name": "Raghu",
                    "order_id": 1,
                    "recipient_id": 377928,
                    "recipient_user_id": 3625901,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        },
            "public_identifier": "pNovCTn7_nQ5imZW6_Nhgw=="
        },
        {
            "aadhaar_enabled": null,
            "checksum": "e3c10aa1faf10d6feab10f348790bcda1fbb4f0ba2a1151f8a9d92e3fc263d14",
            "created_time": 1557731210,
            "fa_aadhaar_enabled": null,
            "id": 14845680,
            "last_modified_time": 1557731210,
            "name": "Offer letter - Anirjit.pdf",
            "pending_file": {
            "aadhaar_enabled": null,
            "created_time": 1557465368,
            "has_markers": 1,
            "is_envelope": 1,
            "id": 235641,
            "is_in_person": 0,
            "is_ordered": 1,
            "last_modified_time": 1557465371,
            "logo": null,
            "name": "Offer letter - Anirjit.pdf",
            "next": 377928,
            "owner_company": "",
            "owner_email": "[email protected]",
            "owner_first_name": "Sunil",
            "owner_last_name": "Patro EK",
            "owner_user_id": 3625900,
            "recipients": [
                {
                    "created_time": 1557422123,
                    "email": "[email protected]",
                    "first_name": "Anirjit",
                    "last_modified_time": 1591780425,
                    "last_name": "Bakshi",
                    "order_id": 1,
                    "recipient_id": 377929,
                    "recipient_user_id": 3625921,
                    "status": "viewed"
                }
            ],
            "status": "incomplete"
        },
            "public_identifier": "ip_dRR0POvdI9cQgwbPqcg=="
        }
 ]

Download the Completed Signature Request as PDF

GET /v1/files/signed/<signed_file_id>/download
GET /v2/rs/envelope/signed/<signed_file_id>/download/merged
GET /v2/rs/envelope/signed/<signed_file_id>/download/split

Delete the Completed Signature Request

DELETE /v1/files/signed/<signed_file_id>
DELETE /v2/rs/envelope/signed/<signed_file_id>