Migrating Embedded Sending
Embedded Sending flows in v2 have been categorised into two sections one each for "self sign" and "request signatures".
Create a embedded sending URL for self signing
POST /v2/signing/url/
{
"file_id": 223221,
"type": "self_sign",
"message": "Employee contract",
"redirect_url": "https://mycompanydomain.io/redirecthere/"
}
POST /v2/me/embedded/url/
{
"file_id": 223221,
"message": "Employee contract",
"redirect_url": "https://mycompanydomain.io/redirecthere/"
}
Fetch all self signed documents
Note: This endpoint is supported only on v2.
GET /v2/me/signed/
{
"count": 2,
"files": [
{
"aadhaar_enabled": null,
"checksum": "a987516b47d84caa1ecb3ddca86589f3b7dec31a7fa77e7f458d5788bfe04282",
"created_time": 1554285219,
"fa_aadhaar_enabled": null,
"id": 14845488,
"last_modified_time": 1554285219,
"name": "Employment Contract - Rajith Noojibial.pdf",
"pending_file": null,
"public_identifier": "izrok4vVhS9hRz3aAzUbeg=="
},
{
"aadhaar_enabled": null,
"checksum": "e9e65ea551760df8bc9c4252fa90fa152d549609bd363a24b2a499aefc94eb21",
"created_time": 1554285323,
"fa_aadhaar_enabled": null,
"id": 14845489,
"last_modified_time": 1554285323,
"name": "Employment Contract - Jens Van Dyck.pdf",
"pending_file": null,
"public_identifier": "MuOSz0k+WpWPDGoMroj72w=="
}]
Fetch details of a self signed document
Note: This endpoint is supported only on v2.
GET /v2/me/signed/<signed_id>/
{
"aadhaar_enabled": null,
"checksum": "e9e65ea551760df8bc9c4252fa90fa152d549609bd363a24b2a499aefc94eb21",
"created_time": 1554285323,
"fa_aadhaar_enabled": null,
"id": 14845489,
"last_modified_time": 1554285323,
"name": "Employment Contract - Jens Van Dyck.pdf",
"pending_file": null,
"public_identifier": "MuOSz0k+WpWPDGoMroj72w=="
}
Download a self signed document
GET /v1/files/signed/<signed_id>/download/
PDF Content
GET /v2/me/signed/<signed_id>/download/
PDF Content
Download certificate for a self signed document
GET /v1/audit-trail/<signed_id>/
PDF Contents of the certificate
GET /v2/me/signed/<signed_id>/certificate/
PDF Contents of the certificate
Delete a self signed document
DELETE /v1/files/signed/<signed_id>/
DELETE /v2/me/signed/<signed_id>/
Create a embedded sending URL for Request Signatures
POST /v2/signing/url/
{
"file_id": 223221,
"type": "rs",
"message": "Employee contract",
"redirect_url": "https://mycompanydomain.io/redirecthere/",
"recipients": [{"first_name": "Rajat", "last_name": "Singh", "email": "[email protected]"}]
}
POST /v2/rs/embedded/url/
{
"file_id": 223221,
"message": "Employee contract",
"redirect_url": "https://mycompanydomain.io/redirecthere/",
"recipients": [{"first_name": "Rajat", "last_name": "Singh", "email": "[email protected]"}]
}
List all request Signatures created using embedded sending
Note: This endpoint is supported only on v2 and does not list the embedded signature requests created using the v1 version.
GET /v2/rs/embedded/
Fetch the details of a request Signatures created using embedded sending
GET /v1/files/pending/<pending_id>/
{
"aadhaar_enabled": 0,
"created_time": 1557915151,
"envelope_size": 0,
"has_markers": 0,
"id": 235799,
"is_envelope": 0,
"is_in_person": 0,
"is_ordered": 0,
"last_modified_time": 1591780366,
"logo": null,
"message": "",
"name": "Employment Agreement - Rajat Singh.pdf",
"next": null,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro",
"owner_user_id": 3625901,
"recipients": [
{
"created_time": 1557915152,
"email": "[email protected]",
"first_name": "Rajat Singh",
"last_modified_time": 1557915152,
"last_name": "",
"order_id": 1,
"recipient_id": 378183,
"recipient_user_id": 3625901,
"status": "not_viewed"
}
],
"status": "incomplete"
}
GET /v2/rs/embedded/<pending_id>/
{
"aadhaar_enabled": 0,
"created_time": 1557915151,
"envelope_size": 0,
"has_markers": 0,
"id": 235790,
"is_envelope": 0,
"is_in_person": 0,
"is_ordered": 0,
"last_modified_time": 1591780366,
"logo": null,
"message": "",
"name": "Employment Agreement - Rajat Singh.pdf",
"next": null,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro",
"owner_user_id": 3625901,
"recipients": [
{
"created_time": 1557915152,
"email": "[email protected]",
"first_name": "Rajat Singh",
"last_modified_time": 1557915152,
"last_name": "",
"order_id": 1,
"recipient_id": 378183,
"recipient_user_id": 3625901,
"status": "not_viewed"
}
],
"status": "incomplete"
}
Remind Signers of Embedded RS
POST /v1/files/pending/<pending_id>/remind/
POST /v2/rs/embedded/<pending_id>/remind/
Cancel an Embedded RS
POST /v1/files/pending/<pending_id>/cancel/
POST /v2/rs/embedded/<pending_id>/cancel/
Fetch all the completed request signatures created using embedded sending
Note: This endpoint is supported only on v2 and does not list the embedded signature requests created using the v1 version.
GET /v2/rs/embedded/signed/
{{
"count": 1,
"files": [
{
"aadhaar_enabled": 0,
"checksum": "e65cb61e14783cd0876f28e0ae6bd89fd58d06c1162e0b24ce01bf0dd9117db5",
"created_time": 1598625964,
"fa_aadhaar_enabled": null,
"id": 14870307,
"is_embedded_sending": 1,
"last_modified_time": 1598625964,
"name": "2019ht13102-2.pdf_28_Aug_2020-144604.pdf",
"pending_file": {
"aadhaar_enabled": 0,
"created_time": 1557915151,
"envelope_size": 0,
"has_markers": 0,
"id": 235790,
"is_envelope": 0,
"is_in_person": 0,
"is_ordered": 0,
"last_modified_time": 1591780366,
"logo": null,
"message": "",
"name": "Employment Agreement - Rajat Singh.pdf",
"next": null,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro",
"owner_user_id": 3625901,
"recipients": [
{
"created_time": 1557915152,
"email": "[email protected]",
"first_name": "Rajat Singh",
"last_modified_time": 1557915356,
"last_name": "",
"order_id": 1,
"recipient_id": 378183,
"recipient_user_id": 3625901,
"status": "finalized"
}
],
"status": "complete"
}
"public_identifier": "YoLRe7I9Us_+FCKwLMyzqA=="
}
]
}}
Fetch Signed document details
GET /v1/files/signed/<signed_id>/
{
"aadhaar_enabled": 0,
"checksum": "e65cb61e14783cd0876f28e0ae6bd89fd58d06c1162e0b24ce01bf0dd9117db5",
"created_time": 1598625964,
"fa_aadhaar_enabled": null,
"id": 14870307,
"is_embedded_sending": 1,
"last_modified_time": 1598625964,
"name": "2019ht13102-2.pdf_28_Aug_2020-144604.pdf",
"pending_file": {
"aadhaar_enabled": 0,
"created_time": 1557915151,
"envelope_size": 0,
"has_markers": 0,
"id": 235790,
"is_envelope": 0,
"is_in_person": 0,
"is_ordered": 0,
"last_modified_time": 1591780366,
"logo": null,
"message": "",
"name": "Employment Agreement - Rajat Singh.pdf",
"next": null,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro",
"owner_user_id": 3625901,
"recipients": [
{
"created_time": 1557915152,
"email": "[email protected]",
"first_name": "Rajat Singh",
"last_modified_time": 1557915356,
"last_name": "",
"order_id": 1,
"recipient_id": 378183,
"recipient_user_id": 3625901,
"status": "finalized"
}
],
"status": "complete"
}
"public_identifier": "YoLRe7I9Us_+FCKwLMyzqA=="
}
]
}
GET /v2/rs/embedded/signed/<signed_id>/
{
"aadhaar_enabled": 0,
"checksum": "e65cb61e14783cd0876f28e0ae6bd89fd58d06c1162e0b24ce01bf0dd9117db5",
"created_time": 1598625964,
"fa_aadhaar_enabled": null,
"id": 14870307,
"is_embedded_sending": 1,
"last_modified_time": 1598625964,
"name": "2019ht13102-2.pdf_28_Aug_2020-144604.pdf",
"pending_file": {
"aadhaar_enabled": 0,
"created_time": 1557915151,
"envelope_size": 0,
"has_markers": 0,
"id": 235790,
"is_envelope": 0,
"is_in_person": 0,
"is_ordered": 0,
"last_modified_time": 1591780366,
"logo": null,
"message": "",
"name": "Employment Agreement - Rajat Singh.pdf",
"next": null,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro",
"owner_user_id": 3625901,
"recipients": [
{
"created_time": 1557915152,
"email": "[email protected]",
"first_name": "Rajat Singh",
"last_modified_time": 1557915356,
"last_name": "",
"order_id": 1,
"recipient_id": 378183,
"recipient_user_id": 3625901,
"status": "finalized"
}
],
"status": "complete"
}
"public_identifier": "YoLRe7I9Us_+FCKwLMyzqA=="
}
]
}
Download Signed document as PDF
GET /v1/files/signed/<signed_id>/download/
PDF Contents
GET /v2/rs/embedded/signed/<signed_id>/download/
PDF Contents
Download Signed document certificate
GET /v1/audit-trail/<signed_id>/
PDF Contents of the certificate
GET /v2/rs/embedded/signed/<signed_id>/certificate/
PDF Contents of the certificate
Delete the Signed document
DELETE /v1/files/signed/<signed_id>/
DELETE /v2/rs/embedded/signed/<signed_id>/
Updated almost 4 years ago