Back to Manage

GET api/V1/Manage/GetEnvelopeXMLByCode/{envelopeCode}

This method is used to download envelope XML by code.

Prerequisites

To be implemented

Steps to follow-:

1. Initialize Envelope – using following url

• api/v1/Envelope/InitializeEnvelope
• Description
  This will create a blank envelope and return Envelope Id.

2. Upload Local Document – using following url

• api/v1/Document/UploadLocalDocument
• Description
  This method is used for uploading document from Local Machine.
  Note-: This service can only be used to upload documents from local machine.
  To upload documents from GoogleDrive, Dropbox and Skydrive please click on their respective links.

3. Delete Document [Optional] – using following url

• api/v1/Document/DeleteDocument/{envelopeId}/{documentId}
• Description
  This will delete document from mentioned Envelope Id or Template Id.

4. Prepare Envelope – using following url

• api/v1/Envelope/PrepareEnvelope
• Description
  This is step 2 of envelope creation. This will take all the required inputs and create document images.

5. Add Signature Control [Optional] – using following url

• api/v1/Control/SignatureControl
• Description
  This will add/edit signature control on the mentioned page for a particular recipient.
  Note-: This service can only be used to add signature.
  To add controls like Text Control, Name Control, Company Control, Title Control, Initial Control, Label Control, Radio Control, Checkbox Control, Date Control and Dropdown Control please click on their respective links.

6. Delete Control [Optional] – using following url

• api/v1/Control/DeleteControl/{envelopeId}/{documentContentId}
• Description
  This will delete control based on the DocumentContentId provided for the mentioned envelope.

7. Clear Controls [Optional] – using following url

• api/v1/Control/ClearControls/{envelopeId}
• Description
  This will add/edit signature control on the mentioned page for a particular recipient.

8. Send Envelope – using following url

• api/v1/Envelope/SendEnvelopeapi/v1/Control/ClearControls/{envelopeId}
• Description
  This will send envelope to signer for mentioned Envelope Id.

Request Information

Lorem ipsum

URI Parameters

Header Parameters

Header Description

Body Parameters

None

Response Information

Resource Description

None

Response Formats

Sample:
Sample not available.