Approvals

This section describes the following services related to approvals:

Retrieve an Existing Approval

GET /packages/{packageId}/documents/{documentId}/approvals/{approvalId}

Description

Retrieve an existing approval.

Resource Information

HTTP Method GET
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval

Example Request

GET https://sandbox.e-signlive.com/api/packages/4a5d3764-e4bb-4eac-8197-1346ea52472d/documents/44dadefac6b990ce/approvals/t6ZijCS9lnw6

Retrieve an Existing Field Related to an Existing Approval

GET /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields/{fieldId}

Description

Retrieve an existing field related to an existing approval.

Resource Information

HTTP Method GET
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval
fieldId Unique identifier of a eSignLive field

Example Request

GET https://sandbox.e-signlive.com/api/packages/4a5d3764-e4bb-4eac-8197-1346ea52472d/documents/44dadefac6b990ce/approvals/t6ZijCS9lnw6/fields/p2b5C3HYFE00

Create a New Approval

POST /packages/{packageId}/documents/{documentId}/approvals

Description

Create a new approval.

Text anchor extraction cannot be used in this API call.

Resource Information

HTTP Method POST
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document

Example Request

POST https://sandbox.e-signlive.com/api/packages/4a5d3764-e4bb-4eac-8197-1346ea52472d/documents/44dadefac6b990ce/approvals

Create a New Field with an Auto-generated Name Related to an Existing Approval

POST /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields

Description

Create a new field with an auto-generated name related to an existing approval.

Text Anchor Extraction cannot be used in this API call.

Resource Information

HTTP Method POST
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval

Example Request

POST https://sandbox.e-signlive.com/api/packages/4a5d3764-e4bb-4eac-8197-1346ea52472d/documents/44dadefac6b990ce/approvals

Create a New Field Related to an Existing Approval

POST /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields/{fieldId}

Description

Create a new field related to an existing approval.

Resource Information

HTTP Method POST
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval
fieldId Unique identifier of a eSignLive field

Example Request

POST https://sandbox.e-signlive.com/api/packages/b3aa04a2-8e34-403c-b7c1-677e62666af0/documents/87384d00900003de/approvals/ibVJi2wFomQN/fields/7cEooFpJcNgX

Response Payload

no content

Send a Notification to Yourself with a Mobile-device Signing Link to an Approval

POST /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/mobile_notification

Description

Send a notification to yourself with a mobile-device signing link to an approval.

Resource Information

HTTP Method POST
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval

Example Request

POST https://sandbox.e-signlive.com/api/packages/b3aa04a2-8e34-403c-b7c1-677e62666af0/documents/87384d00900003de/approvals/ibVJi2wFomQN/mobile_notification

Response Payload

no content

Update all Approvals on a Document

PUT /packages/{packageId}/documents/{documentId}/approvals

Update all approvals on a document.

Modify an Existing Approval

PUT /packages/{packageId}/documents/{documentId}/approvals/{approvalId}

Description

Modify an existing approval.

Resource Information

HTTP Method PUT
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval

Example Request

PUT https://sandbox.e-signlive.com/api/packages/4928d0a5-8d1e-4df4-ae67-168bacdf57e0/documents/9866306389e53904/approvals/d80uxpAQHE45

Update an Existing Field Related to an Existing Approval

PUT /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields/{fieldId}

Description

Update an existing field related to an existing approval.

Resource Information

HTTP Method PUT
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval
fieldId Unique identifier of a eSignLive field

Example Request

PUT https://sandbox.e-signlive.com/api/packages/4928d0a5-8d1e-4df4-ae67-168bacdf57e0/documents/9866306389e53904/approvals/d80uxpAQHE45/fields/PI3NC3HAkpY9

Delete an Existing Approval

DELETE /packages/{packageId}/documents/{documentId}/approvals/{approvalId}

Description

Delete an existing approval.

Resource Information

HTTP Method DELETE
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval

Example Request

DELETE https://sandbox.e-signlive.com/api/packages/41c984cc-1f07-4b43-adcf-ea8f77f8deb2/documents/b62d99c854138da8/approvals/7e7pOggZPssM

Delete an Existing Field Related to an Existing Approval

DELETE /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields/{fieldId}

Description

Delete an existing field related to an existing approval.

Resource Information

HTTP Method DELETE
Resource Family approvals
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

packageId Unique identifier of a eSignLive package
documentId Unique identifier of a eSignLive document
approvalId Unique identifier of a eSignLive approval
fieldId Unique identifier of a eSignLive field

Example Request

DELETE https://sandbox.e-signlive.com/api/packages/41c984cc-1f07-4b43-adcf-ea8f77f8deb2/documents/b62d99c854138da8/approvals/p2NCzMYPpwsO/fields/EsMOP9pvST4Z