Migrating Signature Request without fields
Customers using the Signature Request API without the fields payload can migrate to the v2 APIs using the following endpoints.
Sending the Signature Request
POST /v1/files/pending/
{
"recipients": [{
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe"
}
],
"message": "Offer letter",
"is_ordered": 0,
"name": "Offer letter-John Doe",
"cc": [{"email": "[email protected]"}],
"embedded_signing": true
}
POST /v2/rs/
{
"recipients": [{
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe"
}
],
"message": "Offer letter",
"is_ordered": 0,
"name": "Offer letter",
"cc": [{"email": "[email protected]"}],
"embedded_signing": true
}
POST https://api.signeasy.com/v2.1/rs/
{
"recipients": [
{
"email": "[email protected]",
"first_name": "john",
"last_name": "doe"
}
],
"original_file_id": 12345,
"name": "RS without fields v2.1 ",
"embedded_signing": true,
"is_ordered": false
}
Fetch information about the pending file
GET /v1/files/pending/<rs_id>
{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "John",
"last_modified_time": 1591780421,
"last_name": "Doe",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
}
GET /v2/rs/<rs_id>
{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - John Doe.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Jane",
"last_modified_time": 1591780421,
"last_name": "Doe",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
}
GET /v2.1/rs/<rs_id>
{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - John Doe.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Jane",
"last_modified_time": 1591780421,
"last_name": "Doe",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
}
List all Signature requests
GET /v2/rs
GET /v1/files/pending
GET /v2.1/rs
{
"count":2,
"files":[
{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - John Doe.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "John",
"last_modified_time": 1591780421,
"last_name": "Doe",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557422123,
"email": "[email protected]",
"first_name": "John",
"last_modified_time": 1591780425,
"last_name": "Doe",
"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/<file_id>/remind
POST /v2.1/rs/{rs_id}/remind
Cancel the Signature Request
POST /v1/files/pending/<file_id>/cancel
POST /v2/rs/<file_id>/cancel
POST /v2.1/rs/{rs_id}/cancel
Retrieve the Completed Signature Request details
GET /v1/files/signed/<signed_file_id>
GET /v2/rs/signed/<signed_file_id>
GET /v2.1/rs/signed/{signed_id}
Retrieve all Completed Signature Requests
GET /v2/rs/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.pdf",
"pending_file": {
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "John",
"last_modified_time": 1591780421,
"last_name": "Doe",
"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 - John Doe.pdf",
"pending_file": {
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235641,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - John Doe.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "John",
"owner_last_name": "Doe",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557422123,
"email": "[email protected]",
"first_name": "John",
"last_modified_time": 1591780425,
"last_name": "Doe",
"order_id": 1,
"recipient_id": 377929,
"recipient_user_id": 3625921,
"status": "viewed"
}
],
"status": "incomplete"
},
"public_identifier": "ip_dRR0POvdI9cQgwbPqcg=="
}
]
GET /v2.1/rs/signed
Download the Completed Signature Request as PDF
GET /v1/files/signed/<signed_file_id>/download
GET /v2/rs/signed/<signed_file_id>/download
GET /v2.1/rs/signed/{signed_id}/download
Delete the Completed Signature Request
DELETE /v1/files/signed/<signed_file_id>
DELETE /v1/files/signed/<signed_file_id>
DELETE /v2.1/rs/signed/{signed_id}
Updated about 2 years ago